Skip to main content
GET
List an objective's key results
Pass objectiveId. The key results come a page at a time, in creation order: limit is 1-200, default 200, and a larger value is 400 too_big. While meta.hasMore is true, pass meta.nextCursor as cursor with the same objectiveId; a cursor from another route, another objective or another credential, or altered, is 400. The list never answers meta.partial. A missing or malformed objective id returns 404 resource_missing.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

objectiveId
string
required

Query Parameters

limit
integer
default:200

Items per page, 1 to 200 (default 200); a larger value is a 400 too_big. A page may hold fewer items than limit while meta.hasMore is true; continue with meta.nextCursor.

Required range: 1 <= x <= 200
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

Key results

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.