Schedules endpoints

Recurrence schedules that start runs of a workflow: create, pause, resume, run now and preview the next occurrences.

Schedules carry no revision, and no operation here reads Expected-Revision (the header, or the SDK's expectedRevision option, is ignored): an update applies to the schedule as it is stored, and the last write wins. Run now answers the new run with its revision.

Base URL https://app.processcart.com/api/v1. Every operation below is also in the OpenAPI document and the interactive reference.

GET /v1/schedules

List schedules. Scope schedules:manage · the key's allowlist narrows the rows (never a 403 — rows outside it are absent) · paginated ({ data, nextCursor, hasMore }). Operation id listSchedules · open in the API reference.

Lists the workspace's recurrence schedules, newest first, each with its recurrence, presets, enabled state and next occurrences. Filter by workflowId or enabled. updatedSince turns the list into an incremental sync ordered by updatedAt ascending (inclusive). A key restricted to workflows or folders lists only the schedules of workflows inside its allowlist.

Query parameters (an unknown parameter is a 422 validation_failed with errors[].code = "unknown_parameter")

Responses

Errors (every code this operation can answer; see Errors)

• 401 invalid_api_key — Invalid API key
• 401 key_revoked — API key revoked
• 401 unauthorized — Authentication required
• 403 insufficient_scope — Insufficient scope
• 405 method_not_allowed — Method not allowed
• 422 validation_failed — Validation failed
• 429 rate_limited — Too many requests
• 500 internal_error — Internal error
• 503 unavailable — Service unavailable

Example response (200)

{
  "data": [
    {
      "id": "12b83373-b279-48e5-86b1-c88e71c9ed29",
      "workflowId": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
      "workflow": {
        "id": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
        "name": "Order fulfillment"
      },
      "name": "Weekly order review",
      "description": "Every Monday at 9:00 AM",
      "recurrence": {
        "freq": "weekly",
        "interval": 1,
        "time": "09:00",
        "startDate": "2026-11-02",
        "weekly": {
          "days": [
            "mon"
          ]
        }
      },
      "timezone": "America/Los_Angeles",
      "namePattern": "{{workflow}} — {{date}}",
      "presetValues": {
        "amount": 250,
        "customer": "Acme Corp"
      },
      "assignmentOverrides": {
        "review": [
          {
            "kind": "user",
            "userId": "d4a284fd-cdc8-43c1-8933-084a811fc33e"
          }
        ],
        "wrapup": [
          {
            "kind": "group",
            "groupId": "98257cc7-dce3-4ca7-a310-ecf91b75e201"
          }
        ]
      },
      "enabled": true,
      "disabledReason": null,
      "lastError": null,
      "consecutiveFailures": 0,
      "nextRunAt": "2026-11-02T17:00:00.000Z",
      "nextOccurrences": [
        "2026-11-02T17:00:00.000Z",
        "2026-11-09T17:00:00.000Z",
        "2026-11-16T17:00:00.000Z"
      ],
      "lastRunAt": null,
      "latestRun": {
        "id": "1185793a-e8fc-4470-a359-826794842cef",
        "name": "Order fulfillment — Oct 10, 2026",
        "startedAt": "2026-10-11T05:27:53.467Z"
      },
      "presetMismatches": [],
      "createdBy": null,
      "createdAt": "2026-10-11T05:27:50.731Z",
      "updatedAt": "2026-10-11T05:27:52.873Z"
    }
  ],
  "nextCursor": null,
  "hasMore": false
}

POST /v1/schedules

Create a schedule. Scope schedules:manage · checked against the key's workflow / folder allowlist (403 not_allowed_for_key outside it) · accepts Idempotency-Key. Operation id createSchedule · open in the API reference.

Creates a schedule that starts runs of one published workflow on a recurrence (daily, weekly, monthly or yearly, at a time on a 5-minute step), with a run-name pattern, preset field values (every required kickoff field needs one; a preset outside its field's bounds is refused with 422, errors[].code invalid_value) and optional per-task assignees. timezone defaults to the workspace's. A recurrence with no future occurrence is refused. Audited. A key restricted to workflows or folders sees only the schedules of workflows inside its allowlist; any other schedule answers 403 not_allowed_for_key.

Request headers

Request body — application/json, ScheduleConfig

Responses

Errors (every code this operation can answer; see Errors)

• 401 invalid_api_key — Invalid API key
• 401 key_revoked — API key revoked
• 401 unauthorized — Authentication required
• 403 insufficient_scope — Insufficient scope
• 403 not_allowed_for_key — Not allowed for this key
• 403 read_only_key — Read-only key
• 403 workflow_not_runnable — Workflow not runnable
• 405 method_not_allowed — Method not allowed
• 409 idempotency_in_progress — Request in progress
• 409 workflow_not_published — Workflow not published
• 409 workflow_trashed — Workflow is in Trash
• 413 payload_too_large — Payload too large
• 415 unsupported_media_type — Unsupported media type
• 422 idempotency_key_reused — Idempotency key reused
• 422 validation_failed — Validation failed
• 429 rate_limited — Too many requests
• 500 internal_error — Internal error
• 503 unavailable — Service unavailable

Example request

{
  "workflowId": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
  "name": "Weekly order review",
  "recurrence": {
    "freq": "weekly",
    "interval": 1,
    "time": "09:00",
    "startDate": "2026-11-02",
    "weekly": {
      "days": [
        "mon"
      ]
    }
  },
  "presetValues": {
    "customer": "Acme Corp",
    "amount": 250
  },
  "assignmentOverrides": {
    "review": [
      {
        "kind": "user",
        "userId": "d4a284fd-cdc8-43c1-8933-084a811fc33e"
      }
    ],
    "wrapup": [
      {
        "kind": "group",
        "groupId": "98257cc7-dce3-4ca7-a310-ecf91b75e201"
      }
    ]
  }
}

Example response (201)

{
  "id": "12b83373-b279-48e5-86b1-c88e71c9ed29",
  "workflowId": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
  "workflow": {
    "id": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
    "name": "Order fulfillment"
  },
  "name": "Weekly order review",
  "description": "Every Monday at 9:00 AM",
  "recurrence": {
    "freq": "weekly",
    "interval": 1,
    "time": "09:00",
    "startDate": "2026-11-02",
    "weekly": {
      "days": [
        "mon"
      ]
    }
  },
  "timezone": "America/Los_Angeles",
  "namePattern": "{{workflow}} — {{date}}",
  "presetValues": {
    "amount": 250,
    "customer": "Acme Corp"
  },
  "assignmentOverrides": {
    "review": [
      {
        "kind": "user",
        "userId": "d4a284fd-cdc8-43c1-8933-084a811fc33e"
      }
    ],
    "wrapup": [
      {
        "kind": "group",
        "groupId": "98257cc7-dce3-4ca7-a310-ecf91b75e201"
      }
    ]
  },
  "enabled": true,
  "disabledReason": null,
  "lastError": null,
  "consecutiveFailures": 0,
  "nextRunAt": "2026-11-02T17:00:00.000Z",
  "nextOccurrences": [
    "2026-11-02T17:00:00.000Z",
    "2026-11-09T17:00:00.000Z",
    "2026-11-16T17:00:00.000Z"
  ],
  "lastRunAt": null,
  "latestRun": null,
  "presetMismatches": [],
  "createdBy": null,
  "createdAt": "2026-10-11T05:27:50.731Z",
  "updatedAt": "2026-10-11T05:27:50.731Z"
}

GET /v1/schedules/{id}

Get a schedule. Scope schedules:manage · checked against the key's workflow / folder allowlist (403 not_allowed_for_key outside it). Operation id getSchedule · open in the API reference.

Returns one schedule with its recurrence in words, presets, assignment overrides, enabled state and pause reason, failure counter, next occurrences, newest run and any presets the published workflow no longer accepts. A key restricted to workflows or folders sees only the schedules of workflows inside its allowlist; any other schedule answers 403 not_allowed_for_key.

Path parameters

Responses

Errors (every code this operation can answer; see Errors)

• 401 invalid_api_key — Invalid API key
• 401 key_revoked — API key revoked
• 401 unauthorized — Authentication required
• 403 insufficient_scope — Insufficient scope
• 403 not_allowed_for_key — Not allowed for this key
• 404 not_found — Not found
• 405 method_not_allowed — Method not allowed
• 422 validation_failed — Validation failed
• 429 rate_limited — Too many requests
• 500 internal_error — Internal error
• 503 unavailable — Service unavailable

Example response (200)

{
  "id": "12b83373-b279-48e5-86b1-c88e71c9ed29",
  "workflowId": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
  "workflow": {
    "id": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
    "name": "Order fulfillment"
  },
  "name": "Weekly order review",
  "description": "Every Monday at 9:00 AM",
  "recurrence": {
    "freq": "weekly",
    "interval": 1,
    "time": "09:00",
    "startDate": "2026-11-02",
    "weekly": {
      "days": [
        "mon"
      ]
    }
  },
  "timezone": "America/Los_Angeles",
  "namePattern": "{{workflow}} — {{date}}",
  "presetValues": {
    "amount": 250,
    "customer": "Acme Corp"
  },
  "assignmentOverrides": {
    "review": [
      {
        "kind": "user",
        "userId": "d4a284fd-cdc8-43c1-8933-084a811fc33e"
      }
    ],
    "wrapup": [
      {
        "kind": "group",
        "groupId": "98257cc7-dce3-4ca7-a310-ecf91b75e201"
      }
    ]
  },
  "enabled": true,
  "disabledReason": null,
  "lastError": null,
  "consecutiveFailures": 0,
  "nextRunAt": "2026-11-02T17:00:00.000Z",
  "nextOccurrences": [
    "2026-11-02T17:00:00.000Z",
    "2026-11-09T17:00:00.000Z",
    "2026-11-16T17:00:00.000Z"
  ],
  "lastRunAt": null,
  "latestRun": {
    "id": "1185793a-e8fc-4470-a359-826794842cef",
    "name": "Order fulfillment — Oct 10, 2026",
    "startedAt": "2026-10-11T05:27:53.467Z"
  },
  "presetMismatches": [],
  "createdBy": null,
  "createdAt": "2026-10-11T05:27:50.731Z",
  "updatedAt": "2026-10-11T05:27:52.873Z"
}

PATCH /v1/schedules/{id}

Update a schedule. Scope schedules:manage · checked against the key's workflow / folder allowlist (403 not_allowed_for_key outside it) · accepts Idempotency-Key. Operation id updateSchedule · open in the API reference.

Changes any subset of name, recurrence, timezone, namePattern, presetValues and assignmentOverrides (presets and overrides are checked against the workflow's current published version). A new recurrence or zone recomputes the next run from now. workflowId cannot change, and enabled is not part of the configuration — use the pause and resume operations (422 unknown_key on enabled). A preset outside its field's bounds is refused (422 invalid_value). Audited.

Path parameters

Request headers

Request body — application/json, SchedulePatch

Responses

Errors (every code this operation can answer; see Errors)

• 401 invalid_api_key — Invalid API key
• 401 key_revoked — API key revoked
• 401 unauthorized — Authentication required
• 403 insufficient_scope — Insufficient scope
• 403 not_allowed_for_key — Not allowed for this key
• 403 read_only_key — Read-only key
• 403 workflow_not_runnable — Workflow not runnable
• 404 not_found — Not found
• 405 method_not_allowed — Method not allowed
• 409 idempotency_in_progress — Request in progress
• 409 workflow_not_published — Workflow not published
• 409 workflow_trashed — Workflow is in Trash
• 413 payload_too_large — Payload too large
• 415 unsupported_media_type — Unsupported media type
• 422 idempotency_key_reused — Idempotency key reused
• 422 validation_failed — Validation failed
• 429 rate_limited — Too many requests
• 500 internal_error — Internal error
• 503 unavailable — Service unavailable

Example request

{
  "name": "Weekly order review (Mondays)"
}

Example response (200)

{
  "id": "12b83373-b279-48e5-86b1-c88e71c9ed29",
  "workflowId": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
  "workflow": {
    "id": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
    "name": "Order fulfillment"
  },
  "name": "Weekly order review (Mondays)",
  "description": "Every Monday at 9:00 AM",
  "recurrence": {
    "freq": "weekly",
    "interval": 1,
    "time": "09:00",
    "startDate": "2026-11-02",
    "weekly": {
      "days": [
        "mon"
      ]
    }
  },
  "timezone": "America/Los_Angeles",
  "namePattern": "{{workflow}} — {{date}}",
  "presetValues": {
    "amount": 250,
    "customer": "Acme Corp"
  },
  "assignmentOverrides": {
    "review": [
      {
        "kind": "user",
        "userId": "d4a284fd-cdc8-43c1-8933-084a811fc33e"
      }
    ],
    "wrapup": [
      {
        "kind": "group",
        "groupId": "98257cc7-dce3-4ca7-a310-ecf91b75e201"
      }
    ]
  },
  "enabled": true,
  "disabledReason": null,
  "lastError": null,
  "consecutiveFailures": 0,
  "nextRunAt": "2026-11-02T17:00:00.000Z",
  "nextOccurrences": [
    "2026-11-02T17:00:00.000Z",
    "2026-11-09T17:00:00.000Z",
    "2026-11-16T17:00:00.000Z"
  ],
  "lastRunAt": null,
  "latestRun": {
    "id": "1185793a-e8fc-4470-a359-826794842cef",
    "name": "Order fulfillment — Oct 10, 2026",
    "startedAt": "2026-10-11T05:27:53.467Z"
  },
  "presetMismatches": [],
  "createdBy": null,
  "createdAt": "2026-10-11T05:27:50.731Z",
  "updatedAt": "2026-10-11T05:27:55.743Z"
}

DELETE /v1/schedules/{id}

Delete a schedule. Scope schedules:manage · checked against the key's workflow / folder allowlist (403 not_allowed_for_key outside it) · accepts Idempotency-Key. Operation id deleteSchedule · open in the API reference.

Deletes the schedule. Runs it already created stay; their schedule member reads null afterwards. Audited.

Path parameters

Request headers

Responses

Errors (every code this operation can answer; see Errors)

• 401 invalid_api_key — Invalid API key
• 401 key_revoked — API key revoked
• 401 unauthorized — Authentication required
• 403 insufficient_scope — Insufficient scope
• 403 not_allowed_for_key — Not allowed for this key
• 403 read_only_key — Read-only key
• 404 not_found — Not found
• 405 method_not_allowed — Method not allowed
• 409 idempotency_in_progress — Request in progress
• 422 idempotency_key_reused — Idempotency key reused
• 422 validation_failed — Validation failed
• 429 rate_limited — Too many requests
• 500 internal_error — Internal error
• 503 unavailable — Service unavailable

POST /v1/schedules/{id}/pause

Pause a schedule. Scope schedules:manage · checked against the key's workflow / folder allowlist (403 not_allowed_for_key outside it) · accepts Idempotency-Key. Operation id pauseSchedule · open in the API reference.

Stops the schedule from creating runs (reason manual). Pausing a paused schedule answers 200 unchanged and keeps its reason. Audited.

Path parameters

Request headers

Responses

Errors (every code this operation can answer; see Errors)

• 401 invalid_api_key — Invalid API key
• 401 key_revoked — API key revoked
• 401 unauthorized — Authentication required
• 403 insufficient_scope — Insufficient scope
• 403 not_allowed_for_key — Not allowed for this key
• 403 read_only_key — Read-only key
• 404 not_found — Not found
• 405 method_not_allowed — Method not allowed
• 409 idempotency_in_progress — Request in progress
• 422 idempotency_key_reused — Idempotency key reused
• 422 validation_failed — Validation failed
• 429 rate_limited — Too many requests
• 500 internal_error — Internal error
• 503 unavailable — Service unavailable

Example response (200)

{
  "id": "12b83373-b279-48e5-86b1-c88e71c9ed29",
  "workflowId": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
  "workflow": {
    "id": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
    "name": "Order fulfillment"
  },
  "name": "Weekly order review",
  "description": "Every Monday at 9:00 AM",
  "recurrence": {
    "freq": "weekly",
    "interval": 1,
    "time": "09:00",
    "startDate": "2026-11-02",
    "weekly": {
      "days": [
        "mon"
      ]
    }
  },
  "timezone": "America/Los_Angeles",
  "namePattern": "{{workflow}} — {{date}}",
  "presetValues": {
    "amount": 250,
    "customer": "Acme Corp"
  },
  "assignmentOverrides": {
    "review": [
      {
        "kind": "user",
        "userId": "d4a284fd-cdc8-43c1-8933-084a811fc33e"
      }
    ],
    "wrapup": [
      {
        "kind": "group",
        "groupId": "98257cc7-dce3-4ca7-a310-ecf91b75e201"
      }
    ]
  },
  "enabled": false,
  "disabledReason": "manual",
  "lastError": null,
  "consecutiveFailures": 0,
  "nextRunAt": null,
  "nextOccurrences": [],
  "lastRunAt": null,
  "latestRun": null,
  "presetMismatches": [],
  "createdBy": null,
  "createdAt": "2026-10-11T05:27:50.731Z",
  "updatedAt": "2026-10-11T05:27:51.759Z"
}

POST /v1/schedules/{id}/resume

Resume a schedule. Scope schedules:manage · checked against the key's workflow / folder allowlist (403 not_allowed_for_key outside it) · accepts Idempotency-Key. Operation id resumeSchedule · open in the API reference.

Turns a paused schedule back on. Resuming never catches up: occurrences missed while paused are skipped and the next run is the first occurrence after now. A schedule whose end date has passed is refused with 409 schedule_ended (change its recurrence first). A schedule whose workflow is unpublished answers 409 workflow_not_published, one in Trash 409 workflow_trashed, and an archived one 403 workflow_not_runnable. Resuming a running schedule answers 200 unchanged. Audited.

Path parameters

Request headers

Responses

Errors (every code this operation can answer; see Errors)

• 401 invalid_api_key — Invalid API key
• 401 key_revoked — API key revoked
• 401 unauthorized — Authentication required
• 403 insufficient_scope — Insufficient scope
• 403 not_allowed_for_key — Not allowed for this key
• 403 read_only_key — Read-only key
• 403 workflow_not_runnable — Workflow not runnable
• 404 not_found — Not found
• 405 method_not_allowed — Method not allowed
• 409 idempotency_in_progress — Request in progress
• 409 schedule_ended — Schedule ended
• 409 workflow_not_published — Workflow not published
• 409 workflow_trashed — Workflow is in Trash
• 422 idempotency_key_reused — Idempotency key reused
• 422 validation_failed — Validation failed
• 429 rate_limited — Too many requests
• 500 internal_error — Internal error
• 503 unavailable — Service unavailable

Example response (200)

{
  "id": "12b83373-b279-48e5-86b1-c88e71c9ed29",
  "workflowId": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
  "workflow": {
    "id": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
    "name": "Order fulfillment"
  },
  "name": "Weekly order review",
  "description": "Every Monday at 9:00 AM",
  "recurrence": {
    "freq": "weekly",
    "interval": 1,
    "time": "09:00",
    "startDate": "2026-11-02",
    "weekly": {
      "days": [
        "mon"
      ]
    }
  },
  "timezone": "America/Los_Angeles",
  "namePattern": "{{workflow}} — {{date}}",
  "presetValues": {
    "amount": 250,
    "customer": "Acme Corp"
  },
  "assignmentOverrides": {
    "review": [
      {
        "kind": "user",
        "userId": "d4a284fd-cdc8-43c1-8933-084a811fc33e"
      }
    ],
    "wrapup": [
      {
        "kind": "group",
        "groupId": "98257cc7-dce3-4ca7-a310-ecf91b75e201"
      }
    ]
  },
  "enabled": true,
  "disabledReason": null,
  "lastError": null,
  "consecutiveFailures": 0,
  "nextRunAt": "2026-11-02T17:00:00.000Z",
  "nextOccurrences": [
    "2026-11-02T17:00:00.000Z",
    "2026-11-09T17:00:00.000Z",
    "2026-11-16T17:00:00.000Z"
  ],
  "lastRunAt": null,
  "latestRun": null,
  "presetMismatches": [],
  "createdBy": null,
  "createdAt": "2026-10-11T05:27:50.731Z",
  "updatedAt": "2026-10-11T05:27:52.873Z"
}

POST /v1/schedules/{id}/run

Start a run from a schedule now. Scope schedules:manage · checked against the key's workflow / folder allowlist (403 not_allowed_for_key outside it) · accepts Idempotency-Key. Operation id runScheduleNow · open in the API reference.

Starts one run right away with the schedule's name pattern, presets and assignment overrides — paused or not, outside the recurrence. Returns the new Run (startedBy: "schedule", schedule set, scheduledFor: null, revision: 1) and an absolute Location. Presets the published workflow no longer accepts are skipped; a required kickoff field without a preset is refused with 422 required_fields_unsatisfied. Audited.

Path parameters

Request headers

Responses

Errors (every code this operation can answer; see Errors)

• 401 invalid_api_key — Invalid API key
• 401 key_revoked — API key revoked
• 401 unauthorized — Authentication required
• 403 insufficient_scope — Insufficient scope
• 403 not_allowed_for_key — Not allowed for this key
• 403 read_only_key — Read-only key
• 403 workflow_not_runnable — Workflow not runnable
• 404 not_found — Not found
• 405 method_not_allowed — Method not allowed
• 409 idempotency_in_progress — Request in progress
• 409 workflow_not_published — Workflow not published
• 409 workflow_trashed — Workflow is in Trash
• 422 idempotency_key_reused — Idempotency key reused
• 422 required_fields_unsatisfied — Required fields unsatisfied
• 422 validation_failed — Validation failed
• 429 rate_limited — Too many requests
• 500 internal_error — Internal error
• 503 unavailable — Service unavailable

Example response (201)

{
  "id": "1185793a-e8fc-4470-a359-826794842cef",
  "name": "Order fulfillment — Oct 10, 2026",
  "status": "active",
  "priority": "none",
  "labels": [],
  "labelDetails": [],
  "dueAt": null,
  "keyDate": null,
  "revision": 1,
  "updatedAt": "2026-10-11T05:27:53.910Z",
  "startedAt": "2026-10-11T05:27:53.467Z",
  "startedBy": "schedule",
  "startedByUserId": null,
  "schedule": {
    "id": "12b83373-b279-48e5-86b1-c88e71c9ed29",
    "name": "Weekly order review"
  },
  "scheduledFor": null,
  "completedAt": null,
  "deletedAt": null,
  "workflow": {
    "id": "39b74b11-d796-42e5-972f-d2a20b5ce7b1",
    "name": "Order fulfillment"
  },
  "versionId": "9973fead-8dbf-4719-9a61-9dc7b126a7f4",
  "url": "https://app.processcart.com/runs/1185793a-e8fc-4470-a359-826794842cef",
  "tasks": [
    {
      "key": "details",
      "title": "Details",
      "kind": "standard",
      "section": "Intake",
      "state": "todo",
      "visible": true,
      "locked": false,
      "dueAt": null,
      "assignees": [],
      "completedAt": null,
      "completedByUserId": null
    },
    {
      "key": "review",
      "title": "Review",
      "kind": "approval",
      "section": "Intake",
      "state": "todo",
      "visible": true,
      "locked": false,
      "dueAt": null,
      "assignees": [
        {
          "kind": "user",
          "userId": "d4a284fd-cdc8-43c1-8933-084a811fc33e"
        }
      ],
      "completedAt": null,
      "completedByUserId": null
    },
    {
      "key": "stop",
      "title": "Sign-off",
      "kind": "standard",
      "section": "Intake",
      "state": "todo",
      "visible": true,
      "locked": false,
      "dueAt": null,
      "assignees": [],
      "completedAt": null,
      "completedByUserId": null
    },
    {
      "key": "wrapup",
      "title": "Wrap up",
      "kind": "standard",
      "section": "Intake",
      "state": "todo",
      "visible": true,
      "locked": true,
      "dueAt": null,
      "assignees": [
        {
          "kind": "group",
          "groupId": "98257cc7-dce3-4ca7-a310-ecf91b75e201"
        }
      ],
      "completedAt": null,
      "completedByUserId": null
    }
  ],
  "fields": [
    {
      "key": "customer",
      "label": "Customer",
      "type": "text",
      "format": "none",
      "taskKey": "details",
      "value": "Acme Corp",
      "formatted": "Acme Corp",
      "visible": true
    },
    {
      "key": "order_code",
      "label": "Order code",
      "type": "text",
      "format": "custom",
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true
    },
    {
      "key": "memo",
      "label": "Memo",
      "type": "textarea",
      "format": null,
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true
    },
    {
      "key": "quantity",
      "label": "Quantity",
      "type": "number",
      "format": "number",
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true
    },
    {
      "key": "amount",
      "label": "Amount",
      "type": "number",
      "format": "currency",
      "taskKey": "details",
      "value": 250,
      "formatted": "$250.00",
      "visible": true
    },
    {
      "key": "fee",
      "label": "Fee",
      "type": "number",
      "format": "currency",
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true
    },
    {
      "key": "rate",
      "label": "Rate",
      "type": "number",
      "format": "percent",
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true
    },
    {
      "key": "rate_text",
      "label": "Rate (text)",
      "type": "text",
      "format": "percent",
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true
    },
    {
      "key": "ship_date",
      "label": "Ship date",
      "type": "date",
      "format": "date",
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true
    },
    {
      "key": "start_time",
      "label": "Start time",
      "type": "time",
      "format": "time",
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true
    },
    {
      "key": "gift_wrap",
      "label": "Gift wrap",
      "type": "dropdown",
      "format": null,
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true,
      "choices": [
        "Yes",
        "No"
      ]
    },
    {
      "key": "tags",
      "label": "Tags",
      "type": "multi_choice",
      "format": null,
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true,
      "choices": [
        "A",
        "B",
        "C"
      ]
    },
    {
      "key": "agree",
      "label": "Agree",
      "type": "checkbox",
      "format": null,
      "taskKey": "details",
      "value": false,
      "formatted": "No",
      "visible": true
    },
    {
      "key": "contact_email",
      "label": "Contact email",
      "type": "email",
      "format": "email",
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true
    },
    {
      "key": "website",
      "label": "Website",
      "type": "url",
      "format": "url",
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true
    },
    {
      "key": "phone",
      "label": "Phone",
      "type": "phone",
      "format": "phone",
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true
    },
    {
      "key": "owner",
      "label": "Owner",
      "type": "members",
      "format": null,
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true
    },
    {
      "key": "steps",
      "label": "Steps",
      "type": "subtasks",
      "format": null,
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true,
      "items": [
        {
          "key": "photos",
          "label": "Photos"
        },
        {
          "key": "invoice",
          "label": "Invoice"
        }
      ]
    },
    {
      "key": "contract",
      "label": "Contract",
      "type": "file",
      "format": null,
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": true
    },
    {
      "key": "double_amount",
      "label": "Double amount",
      "type": "formula",
      "format": "currency",
      "taskKey": "details",
      "value": 500,
      "formatted": "$500.00",
      "visible": true
    },
    {
      "key": "source",
      "label": "Source",
      "type": "hidden",
      "format": null,
      "taskKey": "details",
      "value": null,
      "formatted": "",
      "visible": false
    }
  ]
}

GET /v1/schedules/{id}/preview

Preview a schedule's next occurrences. Scope schedules:manage · checked against the key's workflow / folder allowlist (403 not_allowed_for_key outside it). Operation id previewSchedule · open in the API reference.

Returns the next count (1–10, default 3) times the schedule creates a run, as UTC instants. For a paused schedule, the occurrences a resume would produce (counted from now); empty once its end date has passed.

Path parameters

Query parameters (an unknown parameter is a 422 validation_failed with errors[].code = "unknown_parameter")

Responses

Errors (every code this operation can answer; see Errors)

• 401 invalid_api_key — Invalid API key
• 401 key_revoked — API key revoked
• 401 unauthorized — Authentication required
• 403 insufficient_scope — Insufficient scope
• 403 not_allowed_for_key — Not allowed for this key
• 404 not_found — Not found
• 405 method_not_allowed — Method not allowed
• 422 validation_failed — Validation failed
• 429 rate_limited — Too many requests
• 500 internal_error — Internal error
• 503 unavailable — Service unavailable

Example response (200)

{
  "occurrences": [
    "2026-11-02T17:00:00.000Z",
    "2026-11-09T17:00:00.000Z",
    "2026-11-16T17:00:00.000Z"
  ]
}