List a project's cards
One page of the project's cards in a state, grouped by step in the project's order.
open holds every step but the last, done the last step, archived the archived cards. Within a step the cards keep the project's own order.
Authorization
Authorization: Bearer <key> Authentication
Headers
The language tag Werk writes the answer's own words in, such as step names and history lines, matched to a language it serves; a card's text stays as written. At a project's paths, the reads of its cards and steps, of a card, its update photos, a file and its reminders, and of follow and reminder invitations, and a document's read-now and consent, take the language of the person's chat with Werk in that project first, while it has one. Without either, the language Werk uses with the person the key or the connection acts for.
Path parameters
The project's id.
Query parameters
Which cards: open, done or archived.
How many cards a page holds.
The cursor from the previous page's nextCursor; left out, the first page.
Response
200 The page of cards.
The page's cards, grouped by step in the project's order.
Show properties of groupsHide properties of groups
The step's id.
The step's name.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.
The translated text, present once ready.
The kind of step as its cards' status.bucket reads it: a step that ends the work reads in_progress while it is not the project's last step.
How many cards of this state the step holds in all.
The step's cards on this page, in the project's own order.
Show properties of itemsHide properties of items
completed when the card is on its project's last step, not_completed when it was archived before it, open otherwise.
The card's id.
The card's number as people write it, with # before it.
The card's title, as written.
The language the card's title and description are written in.
The title in the reader's language, when it is written in another.
Show properties of titleTranslationHide properties of titleTranslation
The reader's language the text is translated into.
ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.
The translated text, present once ready.
The step the card is on, with where that step sits in the work.
Show properties of statusHide properties of status
The id of the step the card is on.
The step's name.
open on a new step, done on the project's last step, active on any other step.
The kind of step the card is on; a step that ends the work reads in_progress while it is not the project's last step.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.
The translated text, present once ready.
How long before the due date its holder and followers get the due notice; none sends no notice.
Who set the due moment; present only for a due date with a time.
Show properties of dueSetByHide properties of dueSetBy
That person's name.
The card's due date, or null when it has none.
Show properties of dueHide properties of due
One of 2 shapes, told apart by kind:
kinddatedate for a due day with no time, datetime for a due moment.
The due day, as YYYY-MM-DD.
kinddatetimedate for a due day with no time, datetime for a due moment.
The due moment, as an ISO 8601 date and time with its offset.
The time zone the due moment was given in, when known.
The card's holder, or null when the card is free.
Show properties of assigneeHide properties of assignee
The holder's person id.
The holder's name as the project shows it.
The holder's initials, for an avatar with no photo.
The holder's photo, when they have one.
Show properties of photoHide properties of photo
The person whose photo it is.
The photo's version, which changes with the photo; its read takes it to fetch the current one.
The card's version, which grows with every change to it.
The card's number in its project, unique there and never reused.
The card's step among its project's steps, as the project defines it.
Show properties of currentStepHide properties of currentStep
The step's id; a change of step sends it as stepId.
The step's name.
The kind of step: new for an open step, in_progress or waiting for one in between, resolved or closed for one that ends the work.
The language the step's name is written in; absent for a step name Werk writes in the reader's language itself.
The step's name in the reader's language, when it is written in another.
Show properties of labelTranslationHide properties of labelTranslation
The reader's language the text is translated into.
ready when text holds the translation, pending while it is being made, failed when it could not be made, paused when no plan pays for translations now.
The translated text, present once ready.
True when the card is archived: it has left the working lists and stays readable and searchable.
How much the card holds.
Show properties of countsHide properties of counts
Photos on the card.
Updates on the card.
Documents on the card.
The card's list: its items checked and in all; absent when the card has no list.
Show properties of checklistHide properties of checklist
List items checked.
List items in all.
The changes the key's person may make to this card by hand now, by action name.
The sizes the key's person chose for this page's cards in Werk's apps; a card left out has none saved.
Show properties of cardSizesHide properties of cardSizes
The card's id.
The size the key's person chose for the card: a row, its usual size, or open.
The cursor that reads the next page as after, or null when none remains.
Errors
invalid_query The query is not in the form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).session_revoked The request carries no session the server holds, or its session has ended.session_expired The session has expired.conversation_not_found The project the request names, or its chat, is not one the signed-in person is in.session_changed The session changed while the request was in flight.cursor_expired The page cursor no longer fits the list as it stands or the arguments it was read with.project_profile_changed The project's setup changed while the cards were read.rate_limited More requests of this kind were sent than Werk takes within the time it counts them over.server_error The server could not complete the request, and it is not known whether a write it holds was made.curl "https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/cards?state=open" \
-H "Authorization: Bearer wk_key_..."const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/cards?state=open", {
headers: {
Authorization: "Bearer wk_key_...",
},
});
const answer = await res.json();{
"groups": [
{
"statusKey": "open",
"label": "Pending",
"bucket": "new",
"total": 1,
"items": [
{
"outcome": "open",
"id": "6e2a8d43-1c7b-4f95-a3d6-0b4e9c1f7a25",
"ref": "#15",
"title": "Paint the hallway",
"language": "en-US",
"status": {
"key": "open",
"label": "Pending",
"category": "open",
"bucket": "new"
},
"dueNoticeLead": "at_due",
"due": null,
"assignee": null,
"version": 1,
"number": 15,
"currentStep": {
"id": "open",
"label": "Pending",
"bucket": "new"
},
"archived": false,
"counts": {
"photos": 0,
"updates": 0,
"documents": 0
}
}
]
},
{
"statusKey": "in_progress",
"label": "In progress",
"bucket": "in_progress",
"total": 1,
"items": [
{
"outcome": "open",
"id": "3c9e5b17-8d2f-4a64-b1e3-7f5a0c9d2b48",
"ref": "#14",
"title": "Order the quartz countertop",
"language": "en-US",
"status": {
"key": "in_progress",
"label": "In progress",
"category": "active",
"bucket": "in_progress"
},
"dueNoticeLead": "at_due",
"due": {
"kind": "datetime",
"at": "2026-11-25T20:00:00.000Z",
"enteredTimeZone": "America/New_York"
},
"dueSetBy": {
"displayName": "Maya Chen"
},
"assignee": {
"personId": "5d1f3a2e-8c4b-4e7a-9f21-3b6c8d0e1a42",
"displayName": "Maya Chen",
"initials": "MC"
},
"version": 7,
"number": 14,
"currentStep": {
"id": "in_progress",
"label": "In progress",
"bucket": "in_progress"
},
"archived": false,
"counts": {
"photos": 0,
"updates": 0,
"documents": 1
}
}
]
},
{
"statusKey": "waiting_parts",
"label": "Waiting for parts",
"bucket": "waiting",
"total": 1,
"items": [
{
"outcome": "open",
"id": "1a7d3f92-6b4e-4c15-8e2a-9f0c5b7d3e81",
"ref": "#12",
"title": "Replace the leaking sink faucet",
"language": "en-US",
"status": {
"key": "waiting_parts",
"label": "Waiting for parts",
"category": "active",
"bucket": "waiting"
},
"dueNoticeLead": "at_due",
"due": null,
"assignee": {
"personId": "8a2e6c14-3f5d-4b9a-a7e2-61c0d9f4b3e8",
"displayName": "Tom Okafor",
"initials": "TO"
},
"version": 4,
"number": 12,
"currentStep": {
"id": "waiting_parts",
"label": "Waiting for parts",
"bucket": "waiting"
},
"archived": false,
"counts": {
"photos": 1,
"updates": 1,
"documents": 0
}
}
]
}
],
"cardSizes": [],
"nextCursor": null
}Send a requestGET
It is sent with the key you give, as you. A change made here is real.
The request could not be sent, or its response could not be read.