API referenceBrands

List my ad accounts

Lists the brands the caller can access, one row per brand with its brandId and ad account. connected: false means the brand has no ad account attached.

GET
/v1/brands
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.

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 my ad accounts

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

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

curl -X GET "https://example.com/v1/brands" \  -H "Authorization: Bearer koast_sk_..."
{  "accounts": [    {      "brandId": 0,      "brandName": "string",      "accountId": "string",      "accountName": "string",      "connected": true,      "active": true,      "organizationId": 0    }  ],  "nextCursor": "string"}

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