GET
/
v1
/
teams
/
{teamId}
/
workflow-statuses
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.workflowStatuses.listWorkflowStatuses({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  query: {
    "appliesTo": process.env.OCTOSPARK_APPLIES_TO ?? "appliesTo",
  },
})
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "colour": "<string>",
      "position": 123,
      "autoPostEligible": true,
      "isTerminal": true,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "usageCount": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

Query Parameters

​
appliesTo
enum<string>
required

Registry to list: content statuses organize posts, while task statuses organize tasks.

Available options:
content,
task

Response

Success

​
data
object[]
required