Goals

Browse the API reference and sample payloads for Time Magic integrations.

Goals

Goals can belong to the user or to a project.

List goals

Subscription required

Endpoint: /api/goals

Returns goals for the authenticated user.

Response body

{
  "goals": [
    {
      "id": "<goal_uuid>",
      "name": "Ship v2"
    }
  ]
}

Get goal

Subscription required

Endpoint: /api/goals/:id

Returns a goal by UUID.

Response body

{
  "goal": {
    "id": "<goal_uuid>",
    "name": "Ship v2"
  }
}

Create goal

Endpoint: /api/goals

Create a goal.

Request body

{
  "goal": {
    "name": "Ship v2"
  }
}

Response body

{
  "goal": {
    "id": "<goal_uuid>",
    "name": "Ship v2"
  }
}

Update goal

Endpoint: /api/goals/:id

Update a goal.

Request body

{
  "goal": {
    "name": "Ship v2"
  }
}

Response body

{
  "goal": {
    "id": "<goal_uuid>",
    "name": "Ship v2"
  }
}

Delete goal

Endpoint: /api/goals/:id

Delete a goal.

Response body

{
  "status": "deleted"
}