Entity reference · v1

key-results

KR-NNNNNNtable key_resultssoft delete

Quantitative key results under an objective. Optional outcome_id closes the loop.

Endpoints

GET/api/v1/key-resultsList key-results

POST/api/v1/key-resultsCreate key-results

GET/api/v1/key-results/{id}Read one

PATCH/api/v1/key-results/{id}Update

DELETE/api/v1/key-results/{id}Soft-delete (?hard=true to skip trash)

POST/api/v1/key-results/{id}/restoreRestore from trash

Writable fields

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

Field	Type	Constraints
objective_id*	uuid
title	string
metric_name	string
baseline	float
target	float
current	float
unit	string
status	string	`on-track \| at-risk \| behind \| completed`
outcome_id	uuid
sort_order	integer
is_draft	boolean
metadata	json

Listing & filtering

Pagination: ?limit=50&offset=0 · max limit 200
Default sort: ?sort=sort_order&order=asc
Sortable fields: created_at · updated_at · sort_order · id_number
Search (?q=): title, metric_name
Filters: ?objective_id= ?status= ?outcome_id= , repeat any filter to OR multiple values
Trash: hidden by default; pass ?include_deleted=true

Examples

curlbash

curl 'https://productos.ca/api/v1/key-results?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/key-results. The token is held in this page only for the request and is never stored.

Try it out

API token

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

GET/api/v1/key-results?limit=3