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

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

const response = await client.workflowSchedules.listWorkflowSchedules({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  query: {},
})
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "brief": "<string>",
      "firePlan": {
        "kind": "times",
        "times": [
          "<string>"
        ]
      },
      "cadence": "0 7 * * 1",
      "selection": {
        "mode": "fixed",
        "agentVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "strategy": "<string>",
      "nextRunAt": "<string>",
      "lastRunAt": "<string>",
      "perRunCreditCeilingDecimillicents": 123,
      "dailyCreditCeilingDecimillicents": 1,
      "pendingItemCap": 50,
      "maxConcurrent": 5,
      "targetSocialAccountIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "pausedAt": "<string>",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "revision": 1,
      "agentOwnedLimits": true
    }
  ]
}

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

​
includeImplicit
enum<string>

true also returns the per-agent manual_implicit schedules that own direct runs (hidden by default).

Available options:
true,
false
​
campaignId
string<uuid>

Only schedules attached to this campaign.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
​
agentId
string<uuid>

Only schedules that run this agent.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

Success

​
data
object[]
required