API referenceStructure Templates

List structure templates

Lists the saved structure templates, rule-based campaign blueprints applied to pipeline cards. Results are cursor-paginated.

GET
/v1/brands/{brandId}/structure-templates
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 structure templates

application/json
  1. response
templates*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/structure-templates" \  -H "Authorization: Bearer koast_sk_..."
{  "templates": [    {      "id": "string",      "property1": null,      "property2": null    }  ],  "nextCursor": "string",  "property1": null,  "property2": null}

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