Get structure template

GET

/v1/brands/{brandId}/structure-templates/{templateId}

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.

templateId*string

Structure template ID. Omit to read the template currently open in the builder from the Current Context block. Pass an explicit id only when acting on a different template than the one in scope.

Length1 <= length

Response Body

Get structure template

application/json

response

[key: string]?unknown

curl -X GET "https://example.com/v1/brands/0/structure-templates/string" \  -H "Authorization: Bearer koast_sk_..."

{  "property1": null,  "property2": null}

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