DevelopersHow to connect an assistantKeys
Reference/Profile/Read

List step templates

GEThttps://api.getwerk.ai/api/v1/step-templates

The step templates a new project can take: Werk's own and the ones the key's person saved.

Werk's own templates that the person hid are left out.

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.

Response

200 The templates.

templatesarray of objects

The step templates a project can start from: Werk's own and the ones the key's person saved.

Show properties of templatesHide properties of templates
idenum or string, uuid

The template's id, which a new project takes as templateId.

Allowed valuessimpletechnicianssoftwarehome
builtInboolean

True for one of Werk's own templates, false for one the key's person saved.

namestring

The template's name, in the reader's language for one of Werk's own.

From 1 to 60 characters
nameSourceobject

The name as stored: one of Werk's own words, or a name as written.

Show properties of nameSourceHide properties of nameSource

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 template.

Allowed valuesproject_steps.templates.simpleproject_steps.templates.techniciansproject_steps.templates.softwareproject_steps.templates.home
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
stepsarray of objects

The template'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

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.
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/step-templates" \
  -H "Authorization: Bearer wk_key_..."
TypeScript
const res = await fetch("https://api.getwerk.ai/api/v1/step-templates", {
  headers: {
    Authorization: "Bearer wk_key_...",
  },
});
const answer = await res.json();
200JSON
{
  "templates": [
    {
      "id": "simple",
      "builtIn": true,
      "name": "Simple",
      "nameSource": {
        "kind": "locale_key",
        "key": "project_steps.templates.simple"
      },
      "steps": [
        {
          "id": "open",
          "label": "Pending",
          "labelSource": {
            "kind": "locale_key",
            "key": "project_steps.steps.open"
          },
          "bucket": "new",
          "position": 0
        },
        {
          "id": "in_progress",
          "label": "In progress",
          "labelSource": {
            "kind": "locale_key",
            "key": "project_steps.steps.in_progress"
          },
          "bucket": "in_progress",
          "position": 1
        },
        {
          "id": "done",
          "label": "Done",
          "labelSource": {
            "kind": "locale_key",
            "key": "project_steps.steps.done"
          },
          "bucket": "resolved",
          "position": 2
        }
      ]
    },
    {
      "id": "c1f5b9d3-8a2e-4c4a-96f8-1a7b9e3c5f97",
      "builtIn": false,
      "name": "Kitchen visit",
      "nameSource": {
        "kind": "text",
        "text": "Kitchen visit"
      },
      "steps": [
        {
          "id": "open",
          "label": "Pending",
          "labelSource": {
            "kind": "locale_key",
            "key": "project_steps.steps.open"
          },
          "bucket": "new",
          "position": 0
        },
        {
          "id": "measured",
          "label": "Measured",
          "labelSource": {
            "kind": "text",
            "text": "Measured"
          },
          "bucket": "in_progress",
          "position": 1
        },
        {
          "id": "done",
          "label": "Done",
          "labelSource": {
            "kind": "locale_key",
            "key": "project_steps.steps.done"
          },
          "bucket": "resolved",
          "position": 2
        }
      ]
    }
  ]
}