API referenceWorkflows

Get workflow

Returns one workflow: its spec, nodes, trigger and status.

GET
/v1/brands/{brandId}/workflows/{workflowId}
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.

workflowId*string
Match^[1-9]\d*$
Length1 <= length

Response Body

Get workflow

application/json
  1. response
[key: string]?unknown
curl -X GET "https://example.com/v1/brands/0/workflows/string" \  -H "Authorization: Bearer koast_sk_..."
{  "property1": null,  "property2": null}

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