Browse Objectives | Taktoria API

{
  "data": [
    {
      "id": "id",
      "organizationId": "organizationId",
      "title": "title",
      "period": "QUARTERLY",
      "year": 1,
      "visibility": "PUBLIC",
      "weight": 1.1,
      "keyResults": [
        {
          "id": "id",
          "objectiveId": "objectiveId",
          "title": "title",
          "weight": 1.1,
          "priority": "P0",
          "draft": true,
          "sortOrder": 1,
          "ownerUserIds": [
            "ownerUserIds",
            "ownerUserIds"
          ],
          "ownerTeamIds": [
            "ownerTeamIds",
            "ownerTeamIds"
          ],
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z",
          "score": 1.1,
          "lastCheckInAt": "2024-01-15T09:30:00Z",
          "metric": {
            "name": "name",
            "kind": "WEBHOOK",
            "paused": true
          }
        },
        {
          "id": "id",
          "objectiveId": "objectiveId",
          "title": "title",
          "weight": 1.1,
          "priority": "P0",
          "draft": true,
          "sortOrder": 1,
          "ownerUserIds": [
            "ownerUserIds",
            "ownerUserIds"
          ],
          "ownerTeamIds": [
            "ownerTeamIds",
            "ownerTeamIds"
          ],
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z",
          "score": 1.1,
          "lastCheckInAt": "2024-01-15T09:30:00Z",
          "metric": {
            "name": "name",
            "kind": "WEBHOOK",
            "paused": true
          }
        }
      ],
      "draft": true,
      "sortOrder": 1,
      "archived": true,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "description": "description",
      "quarter": 1,
      "team": {
        "id": "id",
        "name": "name"
      },
      "teamId": "teamId",
      "owner": {
        "id": "id",
        "name": "name",
        "email": "email",
        "image": "image"
      },
      "ownerUserId": "ownerUserId",
      "score": 1.1
    },
    {
      "id": "id",
      "organizationId": "organizationId",
      "title": "title",
      "period": "QUARTERLY",
      "year": 1,
      "visibility": "PUBLIC",
      "weight": 1.1,
      "keyResults": [
        {
          "id": "id",
          "objectiveId": "objectiveId",
          "title": "title",
          "weight": 1.1,
          "priority": "P0",
          "draft": true,
          "sortOrder": 1,
          "ownerUserIds": [
            "ownerUserIds",
            "ownerUserIds"
          ],
          "ownerTeamIds": [
            "ownerTeamIds",
            "ownerTeamIds"
          ],
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z",
          "score": 1.1,
          "lastCheckInAt": "2024-01-15T09:30:00Z",
          "metric": {
            "name": "name",
            "kind": "WEBHOOK",
            "paused": true
          }
        },
        {
          "id": "id",
          "objectiveId": "objectiveId",
          "title": "title",
          "weight": 1.1,
          "priority": "P0",
          "draft": true,
          "sortOrder": 1,
          "ownerUserIds": [
            "ownerUserIds",
            "ownerUserIds"
          ],
          "ownerTeamIds": [
            "ownerTeamIds",
            "ownerTeamIds"
          ],
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z",
          "score": 1.1,
          "lastCheckInAt": "2024-01-15T09:30:00Z",
          "metric": {
            "name": "name",
            "kind": "WEBHOOK",
            "paused": true
          }
        }
      ],
      "draft": true,
      "sortOrder": 1,
      "archived": true,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "description": "description",
      "quarter": 1,
      "team": {
        "id": "id",
        "name": "name"
      },
      "teamId": "teamId",
      "owner": {
        "id": "id",
        "name": "name",
        "email": "email",
        "image": "image"
      },
      "ownerUserId": "ownerUserId",
      "score": 1.1
    }
  ],
  "hasMore": true,
  "total": 1,
  "rollup": {
    "overall": {
      "scored": 1,
      "total": 1,
      "score": 1.1
    },
    "byPriority": {
      "P0": {
        "scored": 1,
        "total": 1,
        "score": 1.1
      }
    }
  },
  "nextCursor": "nextCursor",
  "period": {
    "period": "QUARTERLY",
    "year": 1,
    "label": "label",
    "quarter": 1
  }
}

Browse, as its page shows it: every objective the caller may see in one fiscal period (the current one unless given, or every period with allPeriods), filtered by teams, priority and words, with the rollup over everything that matches. A key sees the whole workspace, private objectives included; a signed-in session what its person may see. Needs objectives:read. To page through every objective without a rollup, use listObjectives.

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:

allPeriodsbooleanOptional

true for every period at once.

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:

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

422

Validation Error

429

Too Many Requests Error