DevelopersHow to connect an assistantKeys
Reference/Projects/Read

List a project's steps

GEThttps://api.getwerk.ai/api/v1/projects/{projectId}/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

AuthorizationheaderRequired

Authorization: Bearer <key> Authentication

Headers

Werk-Localestring

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

projectIdstring, uuidRequired

The project's id.

Response

200 The project's steps.

capabilitiesobject

What the key's person may do with the project now.

Show properties of capabilitiesHide properties of capabilities
inviteboolean

True when the key's person may invite people to the project.

managePeopleboolean

True when they may manage the project's people.

changeRolesboolean

True when they may make a person an admin or a member.

removePeopleboolean

True when they may remove people from the project.

editListsboolean

True when they may change the project's steps.

archiveboolean

True when they may archive the project.

restoreboolean

True when they may bring the project back from the archive.

deleteboolean

True when they may delete the project.

transferOwnershipboolean

True when they may hand the project to another person and leave it.

renameboolean

True when they may rename the project.

changePhotoboolean

True when they may change the project's photo.

leaveboolean

True when they may leave the project.

configVersioninteger

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.

At least 1
stepsarray of objects

The project's steps, in order.

From 2 to 100 items
Show properties of stepsHide properties of steps
idstring

The step's id; a card's step names it as stepId.

Up to 64 characters
labelstring

The step's name, in the reader's language when it is one of Werk's own words.

From 1 to 60 characters
labelLanguagestring

The language a name the project wrote is written in; absent for one of Werk's own words.

From 2 to 64 characters
labelTranslationobject

A name the project wrote, in the reader's language, when it is written in another.

Show properties of labelTranslationHide properties of labelTranslation
languagestring

The reader's language the text is translated into.

From 2 to 64 characters
stateenum

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.

Allowed valuesreadypendingfailedpaused
textstring

The translated text, present once ready.

labelSourceobject

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_key
kindenum

locale_key for one of Werk's own words, text for a name as written.

Allowed valueslocale_key
keyenum

Which of Werk's own words names the step.

Allowed valuesproject_steps.steps.openproject_steps.steps.in_progressproject_steps.steps.waiting_partsproject_steps.steps.doneproject_steps.steps.paidproject_steps.steps.in_review
kindtext
kindenum

locale_key for one of Werk's own words, text for a name as written.

Allowed valuestext
textstring

The name, as written.

From 1 to 60 characters
bucketenum

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.

Allowed valuesnewin_progresswaitingresolvedclosed
positioninteger

The step's place among the project's steps, from 0.

From 0 to 99
cardCountinteger

How many cards are on the step.

At least 0

Errors

400invalid_queryThe 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).
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
404conversation_not_foundThe project the request names, or its chat, is not one the signed-in person is in.
409session_changedThe session changed while the request was in flight.
rate_limitedMore requests of this kind were sent than Werk takes within the time it counts them over.
500server_errorThe server could not complete the request, and it is not known whether a write it holds was made.
curl
curl "https://api.getwerk.ai/api/v1/projects/2f6c9e41-7a3b-4d58-9c1e-0b8d4f2a6e73/steps" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
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();
200JSON
{
  "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
    }
  ]
}