Checklist
A named, ordered container of checklist items on a task. Create requires taskId (immutable after create). Items live on the separate checklistItem resource (?expand=checklistItems to materialize them inline). Deleting a checklist deletes its items.
List Checklists
List checklists. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 3 fields. Ordered by order unless you pass sort.
Required scope: checklists:read
query Parameters
projectIdRestrict the list to one project. Omit to list checklists across every project you can access.
sortField to sort by. Prefix with - for descending (-createdAt); a createdAt:desc / createdAt:asc suffix works too, but never both markers at once. Default: order. Listing without projectId orders by -updatedAt instead.
cursorOpaque cursor for the next page (the envelope nextCursor).
limitItems per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow nextCursor instead of assuming one page held everything.
includeTotalWhen true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.
expandComma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.
name[eq]Filter where name equals.
name[contains]Filter where name contains.
name[startsWith]Filter where name starts with.
taskId[eq]Filter where taskId equals.
taskId[in]Filter where taskId is one of (comma-separated list).
createdAt[gt]Filter where createdAt is greater than.
createdAt[gte]Filter where createdAt is greater than or equal to.
createdAt[lt]Filter where createdAt is less than.
createdAt[lte]Filter where createdAt is less than or equal to.
List Checklists › Responses
OK
The page of results.
totalTotal rows matching the query (across pages).
limithasMorenextCursorOpaque cursor for the next page; null on the last page.
Create Checklist
Create a Checklist. Server-assigned fields are ignored if sent.
Required scope: checklists:write
query Parameters
expandComma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.
Headers
Idempotency-KeyOptional replay key (see Idempotent requests above).
Create Checklist › Request Body
nameChecklist name — a group of steps on the task.
taskIdTask this checklist belongs to. Required on create; immutable afterwards.
orderFractional rank of the checklist within its task. To reposition, send the midpoint of the two neighbours' ranks.
Create Checklist › Responses
Created
idUnique identifier for this resource.
createdAtCreation timestamp.
nameChecklist name — a group of steps on the task.
taskIdTask this checklist belongs to. Required on create; immutable afterwards.
updatedAtLast update timestamp.
createdByActorIdWho created this record — a person, an agent, an automation or the system itself. Read-only, stamped by the server on writes made through this API, and null on records created any other way, so treat it as present-or-null rather than always populated. This is an actor id (a UUID), not a member id: look it up with GET /actors/{id}, whose memberId gives you the person to use against /members.
updatedByActorIdWho last wrote to this record — a person, an agent, an automation or the system itself. Read-only, stamped by the server on writes made through this API, and null on records last written any other way, so treat it as present-or-null rather than always populated. This is an actor id (a UUID), not a member id: look it up with GET /actors/{id}, whose memberId gives you the person to use against /members.
createdByActorTypeThe creator actor's type (human, agent, cron, recurringTask, automation, outboxRetry, systemDefault). Server-derived from actors.type; read-only, not directly writable.
updatedByActorTypeThe last writer actor's type (human, agent, cron, recurringTask, automation, outboxRetry, systemDefault). Server-derived from actors.type via the row's updatedByActorId; read-only, not directly writable.
orderFractional rank of the checklist within its task. To reposition, send the midpoint of the two neighbours' ranks.
The related Task, present only when you pass ?expand=task.
The linked Checklist Item rows, present only when you pass ?expand=checklistItems.
The related Actor, present only when you pass ?expand=createdByActor.
The related Actor, present only when you pass ?expand=updatedByActor.
Get Checklist
Retrieve a single Checklist by id.
Required scope: checklists:read
path Parameters
id^[0-9A-Za-z_!]+$ · requiredId of the Checklist.
query Parameters
expandComma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.
Get Checklist › Responses
OK
idUnique identifier for this resource.
createdAtCreation timestamp.
nameChecklist name — a group of steps on the task.
taskIdTask this checklist belongs to. Required on create; immutable afterwards.
updatedAtLast update timestamp.
createdByActorIdWho created this record — a person, an agent, an automation or the system itself. Read-only, stamped by the server on writes made through this API, and null on records created any other way, so treat it as present-or-null rather than always populated. This is an actor id (a UUID), not a member id: look it up with GET /actors/{id}, whose memberId gives you the person to use against /members.
updatedByActorIdWho last wrote to this record — a person, an agent, an automation or the system itself. Read-only, stamped by the server on writes made through this API, and null on records last written any other way, so treat it as present-or-null rather than always populated. This is an actor id (a UUID), not a member id: look it up with GET /actors/{id}, whose memberId gives you the person to use against /members.
createdByActorTypeThe creator actor's type (human, agent, cron, recurringTask, automation, outboxRetry, systemDefault). Server-derived from actors.type; read-only, not directly writable.
updatedByActorTypeThe last writer actor's type (human, agent, cron, recurringTask, automation, outboxRetry, systemDefault). Server-derived from actors.type via the row's updatedByActorId; read-only, not directly writable.
orderFractional rank of the checklist within its task. To reposition, send the midpoint of the two neighbours' ranks.
The related Task, present only when you pass ?expand=task.
The linked Checklist Item rows, present only when you pass ?expand=checklistItems.
The related Actor, present only when you pass ?expand=createdByActor.
The related Actor, present only when you pass ?expand=updatedByActor.
Delete Checklist
Permanently delete this Checklist. This cannot be undone.
Required scope: checklists:delete
path Parameters
id^[0-9A-Za-z_!]+$ · requiredId of the Checklist.
Headers
Idempotency-KeyOptional replay key (see Idempotent requests above).
Delete Checklist › Responses
No Content
Update Checklist
Partially update a Checklist. Only the fields you send are changed.
Required scope: checklists:write
path Parameters
id^[0-9A-Za-z_!]+$ · requiredId of the Checklist.
query Parameters
expandComma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.
Headers
Idempotency-KeyOptional replay key (see Idempotent requests above).
Update Checklist › Request Body
nameChecklist name — a group of steps on the task.
orderFractional rank of the checklist within its task. To reposition, send the midpoint of the two neighbours' ranks.
expectedUpdatedAtOptional concurrency guard: the updatedAt you last read. If the resource has changed since, the update is rejected with 409 instead of overwriting the other writer. Re-read, re-derive your change from the current values, and retry with the fresh updatedAt.
Update Checklist › Responses
OK
idUnique identifier for this resource.
createdAtCreation timestamp.
nameChecklist name — a group of steps on the task.
taskIdTask this checklist belongs to. Required on create; immutable afterwards.
updatedAtLast update timestamp.
createdByActorIdWho created this record — a person, an agent, an automation or the system itself. Read-only, stamped by the server on writes made through this API, and null on records created any other way, so treat it as present-or-null rather than always populated. This is an actor id (a UUID), not a member id: look it up with GET /actors/{id}, whose memberId gives you the person to use against /members.
updatedByActorIdWho last wrote to this record — a person, an agent, an automation or the system itself. Read-only, stamped by the server on writes made through this API, and null on records last written any other way, so treat it as present-or-null rather than always populated. This is an actor id (a UUID), not a member id: look it up with GET /actors/{id}, whose memberId gives you the person to use against /members.
createdByActorTypeThe creator actor's type (human, agent, cron, recurringTask, automation, outboxRetry, systemDefault). Server-derived from actors.type; read-only, not directly writable.
updatedByActorTypeThe last writer actor's type (human, agent, cron, recurringTask, automation, outboxRetry, systemDefault). Server-derived from actors.type via the row's updatedByActorId; read-only, not directly writable.
orderFractional rank of the checklist within its task. To reposition, send the midpoint of the two neighbours' ranks.
The related Task, present only when you pass ?expand=task.
The linked Checklist Item rows, present only when you pass ?expand=checklistItems.
The related Actor, present only when you pass ?expand=createdByActor.
The related Actor, present only when you pass ?expand=updatedByActor.