Sign in
Goals

Create Goal

post/api/v1/goals

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Headers

X-API-Keystring nullable

Request body

titlestring required
descriptionstring nullable
owner_type'user' | 'team' | 'department' | 'organization'
owner_idstring nullable
goal_type'task' | 'project' | 'objective' | 'policy' | 'research'
status'proposed' | 'active' | 'blocked' | 'completed' | 'abandoned'
priorityinteger
due_atstring date-time nullable
confidencenumber
visibility_scope'personal' | 'team' | 'department' | 'division' | 'organization'
scope_idstring nullable
tagsstring[]
metadataobject

Response

Successful Response

created_atstring date-time required
updated_atstring date-time required
idstring required
organization_idstring required
created_by_user_idstring nullable required
owner_type'user' | 'team' | 'department' | 'organization' required
owner_idstring nullable required
titlestring required
descriptionstring nullable required
goal_type'task' | 'project' | 'objective' | 'policy' | 'research' required
status'proposed' | 'active' | 'blocked' | 'completed' | 'abandoned' required
priorityinteger required
due_atstring date-time nullable required
completed_atstring date-time nullable required
confidencenumber required
visibility_scope'personal' | 'team' | 'department' | 'division' | 'organization' required
scope_idstring nullable required
tagsstring[] required
metadataobject

Changes

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