openapi: 3.1.0
info:
title: Process Street Public Attachments Scheduled Workflows API
version: '1.1'
description: "The Process Street API is organized around REST. Our API has predictable resource-oriented URLs,\naccepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response\ncodes, authentication, and verbs.\n\nAn [MCP server](https://www.process.st/help/docs/mcp-server/) is also available for integrating with AI agents and tools.\n\n## Core concepts\n\n**Workflow vs Workflow Run.** A **Workflow** (sometimes called a \"playbook\" or template) is the reusable\ndefinition — tasks, form fields, logic, automations. A **Workflow Run** (sometimes called a \"checklist\")\nis one *instance* of running a Workflow. You list available templates via `listWorkflows`; you start one\nvia `createWorkflowRun` (or by scheduling); and you read or update the live state of an in-progress run\nvia the Workflow Runs / Tasks / Form Field Values endpoints. The two are easy to confuse — when in doubt,\n\"Workflow\" is the *blueprint*, \"Workflow Run\" is *one execution*.\n\n**Pages** are similar but standalone: a Page is a content document (no tasks/form fields). A\n**Page Revision** is a versioned snapshot of its content.\n\n## IDs\n\nAll resource IDs are opaque 22-character URL-safe strings (Muids — a base64-encoded UUID). Treat them\nas opaque tokens. Do not parse them, attempt to sort by them, or assume any internal structure. You can\ncompare two IDs for equality with a plain string comparison.\n\n## Dates and times\n\nAll timestamps in requests and responses are ISO-8601, UTC, with millisecond precision\n(e.g. `2024-09-15T14:32:00.000Z`). For date-only fields (typically due dates), use a calendar date\n(`2024-09-15`).\n\n## Pagination\n\nList endpoints page through results using an opaque cursor named `_` (yes, just an underscore).\nThe flow:\n\n1. Call the list endpoint without `_` to get the first page.\n2. Each response includes a `links[]` array. If there are more pages, you'll find an entry with\n `name: \"next\"` whose `href` is a fully-formed URL you can `GET` directly.\n3. Keep following `next.href` until the `next` link is absent — that's the end.\n\nYou can also reuse the `_` value from one response by passing it as the `_` query parameter on the\nnext request, but **following the `href` is simpler and forward-compatible**.\n\n## Authentication\n\nEvery request must include an API key as `X-API-KEY: <your-key>`. Generate keys from your\norganization settings in the Process Street app. Each key carries the permissions of the user that\ncreated it.\n\n## Idempotency and retries\n\n- `GET` requests are safe to retry on any error.\n- `PUT` requests are idempotent — calling them twice with the same body is equivalent to calling once.\n Safe to retry on `5xx`.\n- `DELETE` is idempotent (deleting an already-deleted resource returns `404`, which is fine to ignore).\n- `POST` is generally **not** safe to blindly retry. For workflow runs, attach a `referenceId`\n on create — calling `createWorkflowRun` twice with the same `referenceId` will return the existing\n run instead of creating a duplicate.\n\n## Errors\n\nErrors are returned as a JSON object with this shape:\n\n```json\n{\n \"error\": \"human-readable message\",\n \"errorCode\": \"NotFound\",\n \"requestId\": \"abc123…\",\n \"details\": { \"fieldPath\": \"what went wrong\" }\n}\n```\n\n**When present**, branch on `errorCode` rather than regex'ing `error` (we may rewrite the wording). Include\n`requestId` if you contact support so we can find the request in our logs.\n\n`errorCode` and `requestId` are populated on responses generated by the public API exception handler, which\ncovers the great majority of errors. A few low-level failures (e.g. JSON parse failures caught before the\nhandler runs, framework-level routing errors) may return an `ErrorInfo` without these fields. In that case,\nfall back to the HTTP status code (`400`/`401`/`403`/`404`/`409`/`422`/`429`/`5xx`) — its semantics match\nthe corresponding `errorCode` value.\n\n## Rate limits\n\nAll requests are subject to rate limits. If you receive a `429` response, wait for the duration\nspecified in the `Retry-After` header before retrying.\n"
servers:
- url: https://public-api.process.st/api/v1.1
tags:
- name: Scheduled Workflows
description: 'A scheduled workflow is a recurring schedule that automatically creates workflow runs.
Use these endpoints to list scheduled workflows and their recurrence rules.'
externalDocs:
url: https://www.process.st/help/docs/scheduled-workflows/
description: Process Street help article
paths:
/scheduled-workflows:
get:
tags:
- Scheduled Workflows
summary: List scheduled workflows
description: Returns a paginated list of scheduled workflows, ordered by next run date.
operationId: listScheduledWorkflows
parameters:
- name: workflowId
in: query
description: Filter by workflow.
required: false
schema:
type: string
- name: search
in: query
description: Case-insensitive substring match on name.
required: false
schema:
type: string
- name: _
in: query
description: 'Opaque pagination cursor. Take this value from the previous response''s `links[]` entry whose `name`
is `"next"` (typically just follow that link''s `href` instead of reading this value).
Omit on the first page. If the previous response had no `next` link, there are no more pages.'
required: false
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiScheduledWorkflowListResponse'
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
security:
- apiKeyAuth: []
- httpAuth: []
post:
tags:
- Scheduled Workflows
summary: Create a scheduled workflow
description: Creates a scheduled workflow that runs a workflow on a recurring schedule.
operationId: createScheduledWorkflow
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateScheduledWorkflowRequest'
examples:
Weekly schedule:
summary: Create a weekly scheduled workflow that runs every Monday
value:
workflowId: kQPGyFpvBp_u62CNL4VBGQ
name: Weekly compliance review
startDate: '2026-07-21T14:53:24.927Z'
timeZone: America/New_York
duePeriod: P7D
rules:
- interval: 1
weekDay: Monday
frequency: Weekly
assigneeEmails:
- alice@example.com
Daily schedule:
summary: Create a daily scheduled workflow with no due period
value:
workflowId: nVxCd_L1CrDBrZKHyRZNfg
name: Daily standup checklist
startDate: '2026-07-21T14:53:24.927Z'
timeZone: Europe/London
rules:
- interval: 1
frequency: Daily
assigneeEmails: []
required: true
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiScheduledWorkflowResponse'
'400':
description: 'Invalid value for: body'
content:
text/plain:
schema:
type: string
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
security:
- apiKeyAuth: []
- httpAuth: []
/scheduled-workflows/{scheduledWorkflowId}:
get:
tags:
- Scheduled Workflows
summary: Get a scheduled workflow
description: Returns a scheduled workflow by its ID.
operationId: getScheduledWorkflow
parameters:
- name: scheduledWorkflowId
in: path
description: The ID of the scheduled workflow.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiScheduledWorkflowResponse'
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
security:
- apiKeyAuth: []
- httpAuth: []
put:
tags:
- Scheduled Workflows
summary: Update a scheduled workflow
description: 'Updates a scheduled workflow. PUT semantics: all mutable fields must be provided. Rules and assignees are fully replaced.'
operationId: updateScheduledWorkflow
parameters:
- name: scheduledWorkflowId
in: path
description: The ID of the scheduled workflow.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateScheduledWorkflowRequest'
examples:
Weekly schedule:
summary: Create a weekly scheduled workflow that runs every Monday
value:
workflowId: sXf7zprzUDUdMuGjgfpACQ
name: Weekly compliance review
startDate: '2026-07-21T14:53:24.927Z'
timeZone: America/New_York
duePeriod: P7D
rules:
- interval: 1
weekDay: Monday
frequency: Weekly
assigneeEmails:
- alice@example.com
Daily schedule:
summary: Create a daily scheduled workflow with no due period
value:
workflowId: ji8VkJFR0SAPQpMHExlE_Q
name: Daily standup checklist
startDate: '2026-07-21T14:53:24.927Z'
timeZone: Europe/London
rules:
- interval: 1
frequency: Daily
assigneeEmails: []
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiScheduledWorkflowResponse'
'400':
description: 'Invalid value for: body'
content:
text/plain:
schema:
type: string
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
security:
- apiKeyAuth: []
- httpAuth: []
delete:
tags:
- Scheduled Workflows
summary: Delete a scheduled workflow
description: Deletes a scheduled workflow and unschedules all future runs.
operationId: deleteScheduledWorkflow
parameters:
- name: scheduledWorkflowId
in: path
description: The ID of the scheduled workflow.
required: true
schema:
type: string
responses:
'204':
description: ''
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorInfo'
security:
- apiKeyAuth: []
- httpAuth: []
components:
schemas:
CreateScheduledWorkflowRequest:
title: CreateScheduledWorkflowRequest
type: object
required:
- workflowId
- startDate
- timeZone
properties:
workflowId:
description: The ID of the Workflow
examples:
- kOj4KAR4KoR91yv8PFVBmg
type: string
name:
description: Display name.
type: string
startDate:
type: string
format: date-time
timeZone:
type: string
duePeriod:
type: string
rules:
type: array
items:
title: PublicApiScheduledWorkflowRule
oneOf:
- title: Daily
type: object
required:
- interval
- frequency
properties:
interval:
description: Recurrence interval. For a Weekly schedule with `interval=2`, fires every other week.
type: integer
format: int32
frequency:
description: 'How often the workflow runs. The other fields on the rule depend on this value:
`Daily` uses only `interval`, `Weekly` adds `weekDay`, `Monthly` adds `by`, `Yearly` uses only `interval`.'
type: string
enum:
- Daily
- Weekly
- Monthly
- Yearly
const: Daily
- title: Monthly
type: object
required:
- interval
- by
- frequency
properties:
interval:
description: Recurrence interval. For a Weekly schedule with `interval=2`, fires every other week.
type: integer
format: int32
by:
description: 'How a `Monthly` rule recurs:
`DayOfMonth` repeats on the same calendar date each month (e.g. the 15th);
`DayOfWeek` repeats on the same weekday-of-month pattern (e.g. the second Tuesday).'
type: string
enum:
- DayOfMonth
- DayOfWeek
frequency:
description: 'How often the workflow runs. The other fields on the rule depend on this value:
`Daily` uses only `interval`, `Weekly` adds `weekDay`, `Monthly` adds `by`, `Yearly` uses only `interval`.'
type: string
enum:
- Daily
- Weekly
- Monthly
- Yearly
const: Monthly
- title: Weekly
type: object
required:
- interval
- weekDay
- frequency
properties:
interval:
description: Recurrence interval. For a Weekly schedule with `interval=2`, fires every other week.
type: integer
format: int32
weekDay:
description: Day of the week the workflow runs on. Only used by `Weekly` rules.
type: string
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
frequency:
description: 'How often the workflow runs. The other fields on the rule depend on this value:
`Daily` uses only `interval`, `Weekly` adds `weekDay`, `Monthly` adds `by`, `Yearly` uses only `interval`.'
type: string
enum:
- Daily
- Weekly
- Monthly
- Yearly
const: Weekly
- title: Yearly
type: object
required:
- interval
- frequency
properties:
interval:
description: Recurrence interval. For a Weekly schedule with `interval=2`, fires every other week.
type: integer
format: int32
frequency:
description: 'How often the workflow runs. The other fields on the rule depend on this value:
`Daily` uses only `interval`, `Weekly` adds `weekDay`, `Monthly` adds `by`, `Yearly` uses only `interval`.'
type: string
enum:
- Daily
- Weekly
- Monthly
- Yearly
const: Yearly
discriminator:
propertyName: frequency
mapping:
Daily: '#/components/schemas/Daily'
Monthly: '#/components/schemas/Monthly'
Weekly: '#/components/schemas/Weekly'
Yearly: '#/components/schemas/Yearly'
assigneeEmails:
type: array
items:
type: string
PublicApiScheduledWorkflowResponse:
title: PublicApiScheduledWorkflowResponse
type: object
required:
- data
properties:
data:
title: PublicApiScheduledWorkflow
type: object
required:
- id
- workflowId
- startDate
- timeZone
- createdDate
- createdBy
- updatedDate
- updatedBy
properties:
id:
title: EntityID
description: The resource's ID.
type: string
workflowId:
description: The ID of the Workflow
examples:
- ii5psnJDWJiSpdsAEcRFlA
type: string
name:
description: Optional display name for the schedule. Defaults to the workflow's name.
type: string
startDate:
description: When the schedule first becomes active. ISO-8601 UTC. Runs are produced from this date forward.
type: string
format: date-time
timeZone:
description: IANA time zone (e.g. `America/New_York`) used when applying the recurrence.
type: string
duePeriod:
description: Optional ISO-8601 duration (e.g. `P3D`) added to each scheduled run's start to compute its due date.
type: string
nextRunDate:
description: When the next workflow run is scheduled to fire. ISO-8601 UTC.
type: string
format: date-time
previousRunDate:
description: When the most recent workflow run was fired. ISO-8601 UTC.
type: string
format: date-time
createdDate:
description: When the resource was first created. ISO-8601 UTC.
type: string
format: date-time
createdBy:
description: User who created the resource.
examples:
- id: iAaSNCU5lWLYGAi663hO8Q
email: jane.doe@example.com
username: Jane Doe
type: object
required:
- id
- email
- username
properties:
id:
title: EntityID
description: The resource's ID.
type: string
email:
description: The user's email address (also their login identifier).
type: string
username:
description: The user's display name (e.g. `Jane Doe`).
type: string
updatedDate:
description: When the resource was last modified. ISO-8601 UTC.
type: string
format: date-time
updatedBy:
description: User who last modified the resource.
examples:
- id: iAaSNCU5lWLYGAi663hO8Q
email: jane.doe@example.com
username: Jane Doe
type: object
required:
- id
- email
- username
properties:
id:
title: EntityID
description: The resource's ID.
type: string
email:
description: The user's email address (also their login identifier).
type: string
username:
description: The user's display name (e.g. `Jane Doe`).
type: string
rules:
description: Recurrence rules that drive the schedule (Daily/Weekly/Monthly/Yearly).
type: array
items:
title: PublicApiScheduledWorkflowRule
oneOf:
- title: Daily
type: object
required:
- interval
- frequency
properties:
interval:
description: Recurrence interval. For a Weekly schedule with `interval=2`, fires every other week.
type: integer
format: int32
frequency:
description: 'How often the workflow runs. The other fields on the rule depend on this value:
`Daily` uses only `interval`, `Weekly` adds `weekDay`, `Monthly` adds `by`, `Yearly` uses only `interval`.'
type: string
enum:
- Daily
- Weekly
- Monthly
- Yearly
const: Daily
- title: Monthly
type: object
required:
- interval
- by
- frequency
properties:
interval:
description: Recurrence interval. For a Weekly schedule with `interval=2`, fires every other week.
type: integer
format: int32
by:
description: 'How a `Monthly` rule recurs:
`DayOfMonth` repeats on the same calendar date each month (e.g. the 15th);
`DayOfWeek` repeats on the same weekday-of-month pattern (e.g. the second Tuesday).'
type: string
enum:
- DayOfMonth
- DayOfWeek
frequency:
description: 'How often the workflow runs. The other fields on the rule depend on this value:
`Daily` uses only `interval`, `Weekly` adds `weekDay`, `Monthly` adds `by`, `Yearly` uses only `interval`.'
type: string
enum:
- Daily
- Weekly
- Monthly
- Yearly
const: Monthly
- title: Weekly
type: object
required:
- interval
- weekDay
- frequency
properties:
interval:
description: Recurrence interval. For a Weekly schedule with `interval=2`, fires every other week.
type: integer
format: int32
weekDay:
description: Day of the week the workflow runs on. Only used by `Weekly` rules.
type: string
enum:
- Sunday
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
frequency:
description: 'How often the workflow runs. The other fields on the rule depend on this value:
`Daily` uses only `interval`, `Weekly` adds `weekDay`, `Monthly` adds `by`, `Yearly` uses only `interval`.'
type: string
enum:
- Daily
- Weekly
- Monthly
- Yearly
const: Weekly
- title: Yearly
type: object
required:
- interval
- frequency
properties:
interval:
description: Recurrence interval. For a Weekly schedule with `interval=2`, fires every other week.
type: integer
format: int32
frequency:
description: 'How often the workflow runs. The other fields on the rule depend on this value:
`Daily` uses only `interval`, `Weekly` adds `weekDay`, `Monthly` adds `by`, `Yearly` uses only `interval`.'
type: string
enum:
- Daily
- Weekly
- Monthly
- Yearly
const: Yearly
discriminator:
propertyName: frequency
mapping:
Daily: '#/components/schemas/Daily'
Monthly: '#/components/schemas/Monthly'
Weekly: '#/components/schemas/Weekly'
Yearly: '#/components/schemas/Yearly'
assigneeEmails:
description: Emails of users automatically assigned to each scheduled run when it's created.
type: array
items:
type: string
links:
description: Navigable HATEOAS links to related resources. Each entry has a `name` (RFC-5988 link relation like `self`, `edit`, `related`), an `href` URL, and a `type` (`Api` for callable endpoints, `App` for browser-facing URLs). Prefer following these `href` values over constructing URLs by hand.
type: array
items:
title: Link
description: A HATEOAS link to a related resource. Use these to navigate between resources without constructing URLs by hand.
type: object
required:
- name
- href
- type
properties:
name:
description: Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
type: string
href:
title: Uri
description: URL of the linked resource.
examples:
- https://api.process.st/api/v1.1/resource/XXX
type: string
rel:
description: Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
type: string
enum:
- Approval Task
- Approvals
- Assignees
- Comment
- Data Set Records
- Data Sets
- Form Field Values
- Subject Task
- Task
- Tasks
- Users
- Webhook
- Workflow
- Workflow Run
type:
description: Whether this link targets an API endpoint or a Process Street app URL. `Api` — a callable API endpoint you can fetch directly. `App` — a browser-facing URL in the Process Street UI.
type: string
enum:
- Api
- App
links:
description: 'Pagination links. When the result has more pages, look for an entry with `name: "next"` — its `href` is the URL to fetch the next page. Absence of `next` means there are no more pages. For single-resource responses this array is typically empty.'
type: array
items:
title: Link
description: A HATEOAS link to a related resource. Use these to navigate between resources without constructing URLs by hand.
type: object
required:
- name
- href
- type
properties:
name:
description: Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
type: string
href:
title: Uri
description: URL of the linked resource.
examples:
- https://api.process.st/api/v1.1/resource/XXX
type: string
rel:
description: Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
type: string
enum:
- Approval Task
- Approvals
- Assignees
- Comment
- Data Set Records
- Data Sets
- Form Field Values
- Subject Task
- Task
- Tasks
- Users
- Webhook
- Workflow
- Workflow Run
type:
description: Whether this link targets an API endpoint or a Process Street app URL. `Api` — a callable API endpoint you can fetch directly. `App` — a browser-facing URL in the Process Street UI.
type: string
enum:
- Api
- App
PublicApiScheduledWorkflowListResponse:
title: PublicApiScheduledWorkflowListResponse
type: object
properties:
data:
description: The list of resources returned by this request.
type: array
items:
title: PublicApiScheduledWorkflow
type: object
required:
- id
- workflowId
- startDate
- timeZone
- createdDate
- createdBy
- updatedDate
- updatedBy
properties:
id:
title: EntityID
description: The resource's ID.
type: string
workflowId:
description: The ID of the Workflow
examples:
- ii5psnJDWJiSpdsAEcRFlA
type: string
name:
description: Optional display name for the schedule. Defaults to the workflow's name.
type: string
startDate:
description: When the schedule first becomes active. ISO-8601 UTC. Runs are produced from this date forward.
type: string
format: date-time
timeZone:
description: IANA time zone (e.g. `America/New_York`) used when applying the recurrence.
type: string
duePeriod:
description: Optional ISO-8601 duration (e.g. `P3D`) added to each scheduled run's start to compute its due date.
type: string
nextRunDate:
description: When the next workflow run is scheduled to fire. ISO-8601 UTC.
type: string
format: date-time
previousRunDate:
description: When the most recent workflow run was fired. ISO-8601 UTC.
type: string
format: date-time
createdDate:
description: When the resource was first created. ISO-8601 UTC.
type: string
format: date-time
createdBy:
description: User who created the resource.
examples:
- id: iAaSNCU5lWLYGAi663hO8Q
email: jane.doe@example.com
username: Jane Doe
type: object
# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/process-street/refs/heads/main/openapi/process-street-scheduled-workflows-api-openapi.yml