Skip to main content
GET
Read goal key results

Authorizations

X-API-Key
string
header
required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Path Parameters

id
string
required
Pattern: [^\s_]\S*

Query Parameters

lastPeriodCount
integer<int32>
Required range: x <= 12

Response

200 - application/json

Key results returned

id
string
status
enum<string>
Available options:
DRAFT,
PUBLISHED,
ACTIVE,
ABANDONED,
COMPLETED
modificationStatus
enum<string>
Available options:
NOT_MODIFIED,
PENDING,
MODIFIED
currentPeriod
object
confidence
enum<string>
Available options:
LOW,
MEDIUM,
HIGH
confidenceSource
enum<string>
Available options:
IMPLICIT,
CHECK_IN
checkInStats
object
clonedFrom
object
goal
object
name
string
context
string
steps
object[]
percentageItems
integer<int32>
latestNote
object