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

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

const response = await client.workflowSchedules.listWorkflowScheduleRuns({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  workflowScheduleId: process.env.OCTOSPARK_WORKFLOW_SCHEDULE_ID ?? "workflowScheduleId",
  query: {},
})
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agentVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "scheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workflowScheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "firingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "decisionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prompt": "<string>",
      "overrides": {
        "timeLimitSeconds": 10800,
        "strategy": "<string>"
      },
      "chatSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "chatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "langfuseTraceId": "<string>",
      "langfuseTraceUrl": "<string>",
      "costDecimillicents": 123,
      "error": "<string>",
      "result": {},
      "startedAt": "<string>",
      "finishedAt": "<string>",
      "createdAt": "<string>"
    }
  ],
  "total": 123,
  "nextCursor": "<string>",
  "prevCursor": "<string>",
  "pageOffset": 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.

​
workflowScheduleId
string
required

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

Query Parameters

​
cursor
string

Pagination cursor returned by the previous page of runs for this schedule.

​
offset
string

a string to be decoded into a number

​
limit
string

a string to be decoded into a number

Response

ListWorkflowScheduleRunsResponse

​
data
object[]
required
​
total
number
required
​
nextCursor
string | null
required

Opaque cursor for the page after this one; null on the last page.

​
prevCursor
string | null
required

Opaque cursor for the page before this one; null on the first page. Lists on the signed cursor standard return a real backwards cursor; older lists echo the request cursor.

​
pageOffset
number | null

Zero-based position of the first row of this page within total (for "Showing 26-50 of 268" and page numbers); null when unknown.