List automations

Lists the brand's monitoring automations, rule-based watchers that run actions such as pause or notify on live campaigns. Filter with status; results are cursor-paginated.

GET

/v1/brands/{brandId}/automations

Authorization

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.

Path Parameters

brandId*integer

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

Query Parameters

status?string

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 automations

application/json

response

automations*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/automations" \  -H "Authorization: Bearer koast_sk_..."

{  "automations": [    {      "automationId": 0,      "automationName": "string",      "status": "string",      "action": "string",      "actionLevel": "string",      "frequency": "string",      "property1": null,      "property2": null    }  ],  "nextCursor": "string",  "property1": null,  "property2": null}

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