API referenceAd Accounts

Get account naming convention

Returns the naming convention templates configured for the ad account at the campaign, ad set and ad levels, with examples.

GET
/v1/brands/{brandId}/ad-accounts/{accountId}/naming-convention
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.

accountId*string

The ad account id (act_… on Meta, biz_… on Whop).

Response Body

Get account naming convention

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

Required scope: read. CLI: koast get-account-naming-convention, see Ad Accounts commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.