List a project's steps
The project's steps in order, each with how many cards are on it.
A card's step is one of these; the first step means open and the last means done.
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.
Response
200 The project's steps.
What the key's person may do with the project now.
Show properties of capabilitiesHide properties of capabilities
True when the key's person may invite people to the project.
True when they may manage the project's people.
True when they may make a person an admin or a member.
True when they may remove people from the project.
True when they may change the project's steps.
True when they may archive the project.
True when they may bring the project back from the archive.
True when they may delete the project.
True when they may hand the project to another person and leave it.
True when they may rename the project.
True when they may change the project's photo.
True when they may leave the project.
The version of the project's settings (its name, steps and archive), which grows with each change to them; such a change sends it as expectedConfigVersion.
The project's steps, in order.
Show properties of stepsHide properties of steps
The step's id; a card's step names it as stepId.
The step's name, in the reader's language when it is one of Werk's own words.
The language a name the project wrote is written in; absent for one of Werk's own words.
A name the project wrote, 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 name as stored: one of Werk's own words, or a name as written. A change of steps sends it back as label.
Show properties of labelSourceHide properties of labelSource
One of 2 shapes, told apart by kind:
kindlocale_locale_key for one of Werk's own words, text for a name as written.
Which of Werk's own words names the step.
kindtextlocale_key for one of Werk's own words, text for a name as written.
The name, as written.
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 step's place among the project's steps, from 0.
How many cards are on the step.
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.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/steps" \
-H "Authorization: Bearer wk_key_..."const res = await fetch("https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/steps", {
headers: {
Authorization: "Bearer wk_key_...",
},
});
const answer = await res.json();{
"capabilities": {
"invite": true,
"managePeople": true,
"changeRoles": true,
"removePeople": true,
"editLists": true,
"archive": true,
"restore": false,
"delete": true,
"transferOwnership": true,
"rename": true,
"changePhoto": true,
"leave": true
},
"configVersion": 6,
"steps": [
{
"id": "open",
"label": "Pending",
"labelSource": {
"kind": "locale_key",
"key": "project_steps.steps.open"
},
"bucket": "new",
"position": 0,
"cardCount": 1
},
{
"id": "in_progress",
"label": "In progress",
"labelSource": {
"kind": "locale_key",
"key": "project_steps.steps.in_progress"
},
"bucket": "in_progress",
"position": 1,
"cardCount": 1
},
{
"id": "waiting_parts",
"label": "Waiting for parts",
"labelSource": {
"kind": "locale_key",
"key": "project_steps.steps.waiting_parts"
},
"bucket": "waiting",
"position": 2,
"cardCount": 1
},
{
"id": "done",
"label": "Done",
"labelSource": {
"kind": "locale_key",
"key": "project_steps.steps.done"
},
"bucket": "resolved",
"position": 3,
"cardCount": 3
},
{
"id": "paid",
"label": "Paid",
"labelSource": {
"kind": "locale_key",
"key": "project_steps.steps.paid"
},
"bucket": "closed",
"position": 4,
"cardCount": 1
}
]
}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.