Skip to main content
Terminology: the action-plan block is the container (created via POST /api/v2/blocks with type: "action-plan"). The individual tasks inside it are called action items and are managed via the endpoints on this page.

Endpoints

Action item fields


List action items

GET /api/v2/action-items Returns action items scoped to a room, page, or specific block. All scope parameters are optional, but at least one should be provided. If blockId is set, pageId must also be set (otherwise the API returns 400).

Scoping

Query parameters

string
Room ID — returns all action items across the room.
string
Page ID — returns all action items on the page.
string
Action-plan block ID — returns items in that block. Requires pageId.
number
Page number (default: 1).
number
Results per page (default: 100, max: 1000).

Response


Create action items

POST /api/v2/action-items
string
required
The page containing the action-plan block.
string
required
The action-plan block to add action items to.
array
required
Array of action item objects.
Example

Update an action item

PATCH /api/v2/action-items/{action_item_id} All fields are optional. assignees replaces the full assignee list.
string
Updated title.
string
Updated description.
"todo" | "in_progress" | "done" | "cancelled"
New status.
string
ISO 8601 start date.
string
ISO 8601 due date.
boolean
Whether hidden from buyers.
string[]
Replaces the full assignee list. Pass an empty array to remove all.
Example

Delete an action item

DELETE /api/v2/action-items/{action_item_id}