List a work item's checklists
/v1/work-items/{item}/checklists in the Work Items API.
curl https://api.example.test/v1/work-items/$ITEM_ID/checklists \ -H "Authorization: Bearer $TOKEN"Answers the item's two definitions, the Definition of Ready then the Definition of Done, each with its entries in order (id, text, required, done, who ticked it and when) and its tally: done_count, total, required_open and complete. The first read of an item seeds both lists from the project's templates (definition_of_ready and definition_of_done under the project's settings); from then on the lists are the item's own, and a later change to a template does not reach them. The same lists come with the item itself under checklists. A client guest's token is refused.
Requires ability
The token must hold this ability, or the call is refused with 403.
MCP tool
Runs the same action from an agent, behind the same ability.
Authorization
bearerToken A personal access token minted in the app under Account Settings, then API Tokens, sent as Authorization: Bearer zg_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team, and optionally to one project, at mint time.
In: header
Path Parameters
The item, bound by the middleware.
uuidResponses
200OKapplication/json
Array of ChecklistResource
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who registered a row answers FORBIDDEN with the same status, and says so in its own description.
On this endpoint: FORBIDDEN: when the token is a client guest's, or the holder's role on the project does not carry work-item:view-any.
404Not foundRESOURCE_NOT_FOUNDapplication/json
An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on