List goals or return one goal by id.

List goals or return one goal by id.

get/v1/goals

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/goals
  • Auth: HTTP bearer

Query parameters

idstring

Return this one goal instead of a list, by its id or the goal_key you gave it.

status'active' | 'paused' | 'completed' | 'archived'

Return only records in this state.

limitinteger

Goals are returned with their current version, latest outcome, and progress history, so their page ceiling stays at 100.

cursorstring

Continue the same filtered read from pagination.next_cursor. The cursor is bound to the exact filters of the read that issued it; replay every other argument unchanged, or start again without cursor.

Response

Goal state envelope.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

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