Sign upLogin
DocumentationAPI Reference
API referenceWorkflows

List workflow states for one team

Returns the ordered workflow for a team the personal access token's user currently belongs to.

GET
/api/v1/workspaces/{workspaceId}/states

Returns the ordered workflow for a team the personal access token's user currently belongs to.

Authorization

machineBearer
AuthorizationBearer <token>

Personal access tokens and supported service-account keys are accepted only in the Authorization header and never in URLs. Each operation documents which principal types it authorizes.

In: header

Path Parameters

workspaceId*string

Workspace UUID. It must match the workspace bound to the credential.

Formatuuid

Query Parameters

teamId*string

Team whose workflow states are requested.

Formatuuid
cursor?string

Opaque, signed cursor returned by the preceding page. Do not inspect or modify it.

Length1 <= length <= 8192
limit?integer

Maximum resources to return.

Range1 <= value <= 100
Default50

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/states?teamId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",      "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",      "name": "string",      "category": "backlog",      "order": 0,      "default": true,      "color": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "hasMore": true,    "nextCursor": "string"  }}

List labels visible in one team context GET

Returns team and workspace-wide labels after current team membership is verified. A personal access token and an explicit team are required in this preview.

List sprints visible to the actor GET

Returns sprints from current team memberships. Personal access token team restrictions are applied before the product query.