Statuses

Fetch statuses

Returns the statuses which text items and library components in the workspace can be set to, in workflow order — from earliest (a first draft) to latest (ready to ship).

A workspace can rename the default statuses or replace the set entirely, so none of the defaults are guaranteed to exist. Read the available statuses here before setting a status or filtering by one rather than assuming any particular key is valid.

get/statuses

Request

  • Base URL: https://api.dittowords.com/v2
  • URL: https://api.dittowords.com/v2/statuses
  • Auth: API key in header Authorization

Response

Returns an array of statuses in the workspace, in workflow order

idstring required

The status's stable identifier. This is the value to send when setting the status field on a text item or library component, and when querying with a statuses filter — never the display name

namestring required

The status's display name, for use anywhere the status is shown to a person — as it appears in the web app and Figma plugin. Not accepted as an identifier when setting or filtering by status

Example response

[
  {
    "id": "NONE",
    "name": "Draft"
  },
  {
    "id": "WIP",
    "name": "In Progress"
  },
  {
    "id": "REVIEW",
    "name": "In Review"
  },
  {
    "id": "FINAL",
    "name": "Final"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.