Workspace

List workflow states

List a project's workflow states. Call this to turn a state name into the id other endpoints need.

get/workspaces/{workspace_slug}/projects/{project_id}/states/

Request

  • Base URL: https://api.plane.so/api/v1
  • URL: https://api.plane.so/api/v1/workspaces/{workspace_slug}/projects/{project_id}/states/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.plane.so/auth/o/authorize-app/, token URL https://api.plane.so/auth/o/token/; client credentials, token URL https://api.plane.so/auth/o/token/, scopes: projects.states:read)

Path parameters

workspace_slugstring required

Workspace identifier from the workspace URL. In https://app.plane.so/my-team/projects/ it is my-team.

project_idstring uuid required

The project the resource belongs to.

Query parameters

cursorstring

Cursor from a previous response, formatted value:offset:is_prev.

per_pageinteger

Records per page.

order_bystring

Field to sort by. Prefix with - for descending order.

expandstring

Comma-separated related fields to inline in the response.

fieldsstring

Comma-separated sparse field set.

external_idstring

Look up by identifier in the originating system.

external_sourcestring

Look up by originating system name.

Response

A cursor-paginated page of workflow states.

total_countinteger

Total matching records across all pages.

countinteger

Records in this page.

total_pagesinteger
total_resultsinteger
next_cursorstring nullable

Pass back as cursor to fetch the next page.

prev_cursorstring nullable
next_page_resultsboolean
prev_page_resultsboolean
grouped_bystring nullable
sub_grouped_bystring nullable

Changes

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