Get Objective | Taktoria API

{
  "archived": true,
  "canEdit": true,
  "createdAt": "2024-01-15T09:30:00Z",
  "draft": true,
  "id": "id",
  "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
      }
    }
  ],
  "organizationId": "organizationId",
  "period": "QUARTERLY",
  "sortOrder": 1,
  "title": "title",
  "updatableKeyResultIds": [
    "updatableKeyResultIds",
    "updatableKeyResultIds"
  ],
  "updatedAt": "2024-01-15T09:30:00Z",
  "visibility": "PUBLIC",
  "weight": 1.1,
  "year": 1,
  "description": "description",
  "owner": {
    "id": "id",
    "name": "name",
    "email": "email",
    "image": "image"
  },
  "ownerUserId": "ownerUserId",
  "quarter": 1,
  "score": 1.1,
  "team": {
    "id": "id",
    "name": "name"
  },
  "teamId": "teamId"
}

With what the caller may do: canEdit and updatableKeyResultIds, as the objective’s page decides what to offer. A key may do everything.

Authentication

AuthorizationBearer

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

Path parameters

objectiveIdstringRequired

Response

This endpoint returns an object.

archivedboolean

canEditboolean

Whether the caller may change it and its key results’ definitions (add, edit, reorder, delete): its owner, its team (or a team inside it), whoever created it, or an app admin of OKR Hub. Always true for a key. It answers by those rules alone: a Viewer of OKR Hub changes nothing whatever it says (403 viewer_only).

createdAtdatetime

draftboolean

Still being worked out, not yet agreed. A label only: a draft is seen, scored, rolled up and checked in on like any other.

idstring

keyResultslist of objects

organizationIdstring

periodenum

Allowed values:

sortOrderinteger

Its place in the workspace's order of objectives, which is set by hand and which every list follows within a period.

titlestring

updatableKeyResultIdslist of strings

The key results the caller may check in on and grade: all of them for anybody who may edit it, and their own (directly or through a team) for anybody else. Every one, for a key.

updatedAtdatetime

visibilityenum

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:

weightdouble

Relative weight when objectives roll up into an average, 0.01 to 100. One carrying twice the weight moves the average twice as much.

yearinteger

The fiscal year, 2000 to 2100, named by the year its Q1 falls in.

descriptionstringOptional

ownerobjectOptional

The person it belongs to. Absent, with team, for an objective with no owner.

ownerUserIdstringOptional

quarterintegerOptional

1-4 for a quarterly objective, absent for an annual one.

scoredoubleOptional

The weighted average of its key results’ grades, or absent when none has been scored. Absent rather than 0.0 on purpose: an unscored objective has not failed, and a zero would say it had.

teamobjectOptional

The team it belongs to. Absent, with owner, for an objective with no owner.

teamIdstringOptional

Errors

404

Not Found Error

429

Too Many Requests Error