JSON API documentation

Project

name is required. Names are trimmed, repeated whitespace is collapsed, and values must be unique per account without regard to case. Names may contain up to 80 characters. General is created automatically and cannot be renamed or deleted.

{
  "project": {
    "name": "Client work"
  }
}

Todo

Shared todos accept assignee_id on create and update. Choose an ID from the project's available_assignees in GET /api/v1/projects, use null to unassign, or omit to keep the current assignee. Responses include a nullable assignee with id and name. Only the owner and accepted members of a shared project can be assigned. Repeating todos keep their assignee; removing a member or moving work outside their access clears the assignment. Personal capacity counts assigned work, plus unassigned work created by that user.

Create and update also accept blocked and blocked_by, which are included in todo responses. Set blocked: true with an optional plain-text name to block an open todo. Update the name alone while blocked, or use an empty string to clear it. Set blocked: false to unblock and clear the name. Completing or cancelling clears blocking; completed and cancelled todos cannot be blocked. Planning and ordering stay unchanged.

title is required when creating. Accepted fields: title, project_id, description, reference_url, estimated_minutes, planned_on, completed, blocked, blocked_by, recurrence_pattern, tag_ids, and tag_names. Create omission uses General; update omission preserves the todo's project. Todo responses include project with id, name, and general. Repeat patterns are daily, weekdays, every_other_day, and weekly.

{
  "todo": {
    "title": "Document the API",
    "project_id": 1,
    "estimated_minutes": 30,
    "planned_on": "2026-10-08",
    "tag_names": [ "integration" ]
  }
}

Progress comment

body is required and accepts up to 2,000 characters.

{
  "comment": {
    "body": "Published the first draft."
  }
}

Meeting note

title, body, and occurred_on are required when creating. Also accepts project_id, duration_minutes, tag_ids, and tag_names. Create omission uses General; update omission preserves the note's project. Responses include project with id, name, and general. Detail responses include read-only follow_up_todos created from the note.

{
  "meeting_note": {
    "title": "API review",
    "project_id": 1,
    "body": "## Decisions\n\n- Publish v1",
    "occurred_on": "2026-10-08",
    "duration_minutes": 25
  }
}

Tag

name is required when creating. color is optional and defaults automatically.

{
  "tag": {
    "name": "integration",
    "color": "emerald"
  }
}