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

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

const response = await client.workflowSchedules.listWorkflowScheduleFirings({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  workflowScheduleId: process.env.OCTOSPARK_WORKFLOW_SCHEDULE_ID ?? "workflowScheduleId",
  query: {},
})
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workflowScheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "day": "<string>",
      "plannedAt": "<string>",
      "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "decisionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "publishAt": "<string>",
      "intendedPublishTimes": [
        "<string>"
      ],
      "skipDetail": "<string>"
    }
  ]
}

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.

​
workflowScheduleId
string
required

Workflow schedule id (UUID), as returned by the list/create workflow-schedules endpoints.

Query Parameters

​
limit
string

a string to be decoded into a number

​
status
enum<string>

Only firings in this status (for example skipped).

Available options:
planned,
fired,
skipped

Response

Success

​
data
object[]
required