Skip to navigation

List My Objectives

My OKRs, as its page shows them, in one fiscal period (the current one unless given): what the person owns, their teams’ (teams inside theirs count), what they wrote with no owner, and what they hold a key result of, showing only those key results and scored on them. With the rollup over every one, not only this page. Needs objectives:read.

A signed-in session is its person. A key has no OKRs of its own, so it gets its maker’s, as it writes as them; once its maker has left the workspace it is refused with 403 forbidden.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

yearintegerOptional

The fiscal year; with quarter, that quarter; alone, the year’s annual objectives.

quarterintegerOptional
periodenumOptional

Says outright whether year means a quarter or the year.

Allowed values:
teamIdstringOptional
Only what these teams, or teams inside them, own or hold a key result of.
priorityenumOptional
Only objectives holding a key result of this priority.
Allowed values:
includeTeamsbooleanOptional

false for what is theirs in person only, not their teams’.

qstringOptional
Words in titles, descriptions, key results, owners and teams. See Searching.
sortstringOptional

order (the workspace’s own, the default), high or low by score, unscored last.

limitintegerOptional

At most 100; 50 when left out.

cursorstringOptional

Response

This endpoint returns an object.
datalist of objects
hasMoreboolean
totalinteger
How many objectives match, on every page.
rollupobject

The big score above a list in the app: every objective that matches (not only this page), each its key results’ weighted mean, averaged by the objectives’ weights. Unscored ones are left out, not counted as zero.

nextCursorstringOptional
periodobjectOptional

The period shown; absent on Browse with allPeriods.

Errors

402
Subscription Required Error
403
Forbidden Error
422
Validation Error
429
Too Many Requests Error