Goals

List goals

get/goals

Request

  • Base URL: https://service.steady.space/api/v2
  • URL: https://service.steady.space/api/v2/goals
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://app.steady.space/oauth/authorize, token URL https://app.steady.space/oauth/token)
    • HTTP bearer

Query parameters

sincestring date

Filter to records on or after this date.

people_ids[]Id[]

Filter to records owned by, contributed to, or otherwise involving these people.

team_ids[]Id[]

Filter to records involving these teams.

goal_ids[]Id[]

Return only these goals. When set, archived goals are included.

pageinteger

Page number (1-indexed).

per_pageinteger

Number of records per page.

Response

A page of goals.

type'goal'
idstring uuid required
titlestring
descriptionstring

Goal description rendered as Markdown.

start_datestring date
end_datestring date
update_cadence'Weekly' | 'Biweekly' | 'Monthly'
owner_idstring uuid
parent_idstring uuid
privateboolean
archivedboolean
progressinteger required

Progress percentage toward completing the goal.

confidenceinteger required

Confidence score, normalized to one of: 30 (Off track), 60 (At risk), or 90 (On track). Returns 100 (On track) if no updates have been reported yet.

confidence_description'Off track' | 'At risk' | 'On track' required

Human-readable label for the confidence score.

contributor_idsId[]
team_idsId[]
urlstring uri required

Changes

No recorded changes to this operation across all 1 revision of this API.