OKRs API

Endpoints

• GET /okrs - list OKRs with key results

• GET /okrs/{okrId} - get one OKR

• POST /okrs - create OKR

• PATCH /okrs/{okrId} - update title/description

• PATCH /okrs/{okrId}/progress - update key result progress

Scopes

okrs:read for GET; okrs:write for POST and PATCH.

List OKRs (GET /okrs)

• limit, offset - pagination

• sessionId - filter by planning session / quarter UUID

curl "https://api.elevale.app/v1/workspaces/{workspaceId}/okrs?limit=10&sessionId={sessionUuid}" \
  -H "Authorization: Bearer elv_pat_..."

Get OKR (GET /okrs/{okrId})

Returns the OKR with its key results included.

Create body (POST)

• sessionId (required) - planning session UUID

• objective - { title, description? }

• keyResults - array of { title, target, unit?, type?, connectedKpiId? }

curl -X POST "https://api.elevale.app/v1/workspaces/{workspaceId}/okrs" \
  -H "Authorization: Bearer elv_pat_..." \
  -H "Content-Type: application/json" \
  -d '{"sessionId":"...","objective":{"title":"Grow enterprise revenue"},"keyResults":[{"title":"Close 5 deals","target":5,"unit":"deals"}]}'

Progress update (PATCH .../progress)

• keyResultId (required)

• currentValue (required)

• notes (optional)

Related

Personal access tokens (PATs) · Scopes and permissions