Carbon

Workflow

The workflow resource.

Basehttps://rest.carbon.ms/workflow
GET/workflow

List workflows

Retrieve a paginated list of workflows. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/workflow
curl --request GET \
  --url 'https://rest.carbon.ms/workflow?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "name": "Example",
    "ownerId": "xyz789",
    "active": true,
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "description": "string"
  }
]
GET/workflow

Retrieve a workflow

Fetch a single workflow by filtering on `id`.

Query parameters

idstring

Match on the workflow's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/workflow
curl --request GET \
  --url 'https://rest.carbon.ms/workflow?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "ownerId": "xyz789",
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "description": "string"
}
POST/workflow

Create a workflow

Create a new workflow.

Body parameters

namestringrequired
descriptionstring
ownerIdstringrequired

References user.id

activebooleanrequired
activeVersionIdstring
nextRunAttimestamp
canvasStateobject
POSThttps://rest.carbon.ms/workflow
curl --request POST \
  --url https://rest.carbon.ms/workflow \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","description":"string","ownerId":"xyz789","active":true}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "ownerId": "xyz789",
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "description": "string"
}
PATCH/workflow

Update a workflow

Update an existing workflow, matched on `id`.

Body parameters

namestringrequired
descriptionstring
ownerIdstringrequired

References user.id

activebooleanrequired
activeVersionIdstring
nextRunAttimestamp
canvasStateobject
PATCHhttps://rest.carbon.ms/workflow
curl --request PATCH \
  --url 'https://rest.carbon.ms/workflow?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "ownerId": "xyz789",
  "active": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "description": "string"
}
DELETE/workflow

Delete a workflow

Delete a workflow, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the workflow to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/workflow
curl --request DELETE \
  --url 'https://rest.carbon.ms/workflow?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content