goals

Get Goals

get/api/v1/goals

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/v1/auth/token)

Query parameters

include_archivedboolean

Cookies

access_tokenstring nullable

Response

Successful Response

created_atstring date-time nullable
updated_atstring date-time nullable
titlestring required
activity_idstring uuid nullable
category_idstring uuid nullable
goal_type'achieve' | 'avoid'

Goal direction.

frequency_type'daily' | 'weekly' | 'monthly'

Goal frequency.

target_countinteger
reminder_timestring nullable
is_pausedboolean
iconstring nullable
color_valueinteger nullable
positioninteger
idstring uuid required
user_idstring uuid required
archived_atstring date-time nullable
current_period_completedinteger
status'success' | 'fail' | 'skipped'

Goal log status for a period.

Changes

No recorded changes to this operation across all 9 revisions of this API.