ProductOSDocs

Entity reference · v1

initiatives

INIT-NNNNNNtable initiativessoft delete

Strategic bets that group features. Carry a hypothesis + success_metric.

Endpoints

GET/api/v1/initiatives
POST/api/v1/initiatives
GET/api/v1/initiatives/{id}
PATCH/api/v1/initiatives/{id}
DELETE/api/v1/initiatives/{id}
POST/api/v1/initiatives/{id}/restore
GET/api/v1/initiatives/{id}/links/features
POST/api/v1/initiatives/{id}/links/features
DELETE/api/v1/initiatives/{id}/links/features/{targetId}
GET/api/v1/initiatives/{id}/links/releases
POST/api/v1/initiatives/{id}/links/releases
DELETE/api/v1/initiatives/{id}/links/releases/{targetId}
GET/api/v1/initiatives/{id}/links/members
POST/api/v1/initiatives/{id}/links/members
DELETE/api/v1/initiatives/{id}/links/members/{targetId}

Writable fields

* required on create. PATCH treats every field as optional.

FieldTypeConstraintsNotes
title*string
problemtext
hypothesistext
statusstringdiscovery | planned | in-progress | shipped | proposed | active | completed | paused | off-track | at-risk
progressinteger≥ 0 · ≤ 100
ownerstring
teamstring
target_datedate
theme_iduuid
success_metricjson
jira_linkstring
figma_linkstring
external_linksjson
is_draftboolean
metadatajson

Listing & filtering

  • Pagination: ?limit=50&offset=0 · max limit 200
  • Default sort: ?sort=created_at&order=desc
  • Sortable fields: created_at · updated_at · title · progress · target_date · id_number
  • Search (?q=): title, problem, hypothesis
  • Filters: ?status= ?owner= ?team= ?theme_id= ?is_draft= , repeat any filter to OR multiple values
  • Trash: hidden by default; pass ?include_deleted=true
  • Expand: ?expand=features,releases

Examples

curlbash
curl 'https://productos.ca/api/v1/initiatives?limit=10' \
  -H "Authorization: Bearer $TOKEN"

Try it out

Paste a token and hit a real endpoint. The request goes from your browser straight to /api/v1/initiatives. The token is held in this page only for the request and is never stored.

Try it out

Issue tokens in Settings → API tokens. Token never leaves this page.

GET/api/v1/initiatives?limit=3

Generated from the API's entity configuration. This page is rebuilt on every deploy, so it always matches the live API.