API referenceWorkflows

List workflows

Lists the organization's workflows, multi-step automations built from nodes such as apply template, launch, review gate and Slack notify, with their status, run count and last run time. Results are cursor-paginated.

GET
/v1/brands/{brandId}/workflows
bearerAuth
headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

brandId*integer

The brand the request acts on. Every brand-scoped resource lives under its brand.

cursor?string

Opaque cursor from the previous page's nextCursor. Omit for the first page.

limit?integer

Page size.

Range1 <= value <= 100
Default50

Response Body

List workflows

application/json
  1. response
workflows*array<>
nextCursor*|

Pass as cursor to read the next page. Null when there is no next page.

[key: string]?unknown
curl -X GET "https://example.com/v1/brands/0/workflows" \  -H "Authorization: Bearer koast_sk_..."
{  "workflows": [    {      "workflowId": 0,      "workflowName": "string",      "type": "string",      "status": "string",      "runCount": 0,      "isRunning": true,      "lastRunAt": "string",      "property1": null,      "property2": null    }  ],  "nextCursor": "string",  "property1": null,  "property2": null}

Required scope: read. CLI: koast list-workflows, see Workflows commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.