Skip to navigation

Get Team Okrs

One team’s page in OKR Hub, by its slug, for a fiscal period (the current one unless given): who is on it, every objective it or a team inside it owns, whole, and those it only holds a key result of, with just those key results; the rollup; and what the caller may do with each objective. Not paged. Needs objectives:read.

Authentication

AuthorizationBearer

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

Path parameters

teamSlugstringRequired

Query parameters

yearintegerOptional

The fiscal year; with quarter, that quarter; alone, the year.

quarterintegerOptional
periodenumOptional
Allowed values:

Response

This endpoint returns an object.
teamobject
periodobject

A fiscal period of the workspace’s own, which need not match the calendar’s: its fiscal year starts in fiscalYearStartMonth, and is named by the year its Q1 falls in.

objectiveslist of objects

Every objective it or a team inside it owns, whole, and those it only holds a key result of, with just those key results and scored on them; in the workspace’s order.

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.

canAddObjectiveboolean

Always true: anybody with a seat may add an objective for any team. A Viewer of OKR Hub may not, whatever this says (403 viewer_only).

Errors

402
Subscription Required Error
404
Not Found Error
422
Validation Error
429
Too Many Requests Error