Get brand website candidates

Returns the brand's saved website, the caller's email domain, the five most recent destination domains in the brand's ads, and whether the brand has a style guide.

GET

/v1/brands/{brandId}/style-guide/website-candidates

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.

Response Body

Get brand website candidates

application/json

response

brandUrl*|

The website saved on the brand.

emailDomain*|

The domain of the user's email. It may be a personal email provider rather than the brand.

recentAdDomains*array<>

Domains the brand's recent ads link to, newest first.

styleGuide*

[key: string]?unknown

curl -X GET "https://example.com/v1/brands/0/style-guide/website-candidates" \  -H "Authorization: Bearer koast_sk_..."

{  "brandUrl": "string",  "emailDomain": "string",  "recentAdDomains": [    {      "domain": "string",      "lastUsedAt": "string",      "property1": null,      "property2": null    }  ],  "styleGuide": {    "exists": true,    "confirmedAt": "string",    "property1": null,    "property2": null  },  "property1": null,  "property2": null}

Required scope: read. CLI: koast get-brand-website-candidates, see Style Guide commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.