Skip to navigation
API ReferenceOkr

List Objectives

Newest year first. Within a year, by quarter from Q4 down, with the year’s annual objectives after its quarters; within a period, in the workspace’s own order (sortOrder), then oldest first.

Authentication

AuthorizationBearer

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

Query parameters

yearintegerOptional
quarterintegerOptional
teamIdstringOptional
What the team and the teams inside it own, and what they hold a key result of, as Browse and the team's page show it.
ownerUserIdstringOptional
visibilityenumOptional
Public objectives are browsable by everyone in the workspace. Private ones are visible to their owner, the members of the owning team, and whoever created them, whoever they belong to. The owners of its key results see it too.
Allowed values:
qstringOptional

Search objectives by their title, description, key results’ titles, owner’s name and team’s name, among those the caller may see (a private objective only by those allowed to see it). Every word must appear in one of those fields; case and accents are ignored; at most 100 characters and 8 words. See Searching under Errors and pagination.

draftbooleanOptional

true lists only drafts and false only what is published; left out, both.

archivedbooleanOptional

true lists only archived objectives; left out or false, only the rest.

limitintegerOptional
cursorstringOptional

Response

This endpoint returns an object.
datalist of objects
hasMoreboolean
nextCursorstringOptional

Errors

401
Unauthorized Error
402
Subscription Required Error
429
Too Many Requests Error