Skip to navigation
API ReferenceOkr

List Team Scores

OKR Hub’s Teams: every organizational team’s score for one fiscal period (the current one unless given), A to Z or by score. A team’s score is rolled up from what it and the teams inside it own and hold a key result of, as its page shows them, among what the caller may see. Needs objectives:read.

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.

quarterintegerOptional
periodenumOptional
Allowed values:
qstringOptional
Words in the team's name.
sortstringOptional

order (A to Z, the default), high or low by score, unscored last.

onlyScoredbooleanOptional

true keeps only the teams with a score.

limitintegerOptional

At most 100; 50 when left out.

cursorstringOptional

Response

This endpoint returns an object.
datalist of objects
hasMoreboolean
totalinteger
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.

nextCursorstringOptional

Errors

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