API referenceObjectives

List key results visible to the actor

Returns key results through the personal access token user's current workspace membership, team membership, scope, and optional team restriction.

GET
/api/v1/workspaces/{workspaceId}/key-results

Returns key results through the personal access token user's current workspace membership, team membership, scope, and optional team restriction.

Authorization

machineBearer
AuthorizationBearer <token>

Personal access tokens and supported service-account keys are accepted only in the Authorization header and never in URLs. Each operation documents which principal types it authorizes.

In: header

Path Parameters

workspaceId*string

Workspace UUID. It must match the workspace bound to the credential.

Formatuuid

Query Parameters

teamId?string

Restrict results to one team allowed by the credential.

Formatuuid
objectiveId?string

Restrict results to one objective.

Formatuuid
cursor?string

Opaque, signed cursor returned by the preceding page. Do not inspect or modify it.

Length1 <= length <= 8192
limit?integer

Maximum resources to return.

Range1 <= value <= 100
Default50

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/key-results"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",      "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",      "objectiveId": "1ac8be30-2b34-409a-be6d-40652b73c978",      "objectiveName": "string",      "sequenceId": 1,      "name": "string",      "measurementType": "percentage",      "startValue": 0.1,      "currentValue": 0.1,      "targetValue": 0.1,      "leadUserId": "b9d7f686-e28e-4725-9fee-fb757798924c",      "contributorIds": [        "68a42d45-c0f0-4dbf-9a1f-c5ca8cd164ea"      ],      "startDate": "2019-08-24T14:15:22Z",      "endDate": "2019-08-24T14:15:22Z",      "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "hasMore": true,    "nextCursor": "string"  }}