Skip to content
AdCrunch
Esc
navigateopen⌘Jpreview

List the Brands

Lists the Brands of your organization. Each row gives the slug, the name, the description, the logo URL, and which narrative sections have content. This call does not give the sections. To read them, read one Brand. Deleted Brands are not in the list.

GET/context/brands/
Authorization
AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>. Two credentials work.

An API key (acr_…) is what a server integration uses. Create one in the AdCrunch console under Settings → API keys — see https://docs.adcrunch.dev/account/api-keys. A key is bound to the organization that was active when you created it, and it keeps acting on that organization whatever you do later. It carries the permissions of the member who created it.

A session issued by the AdCrunch sign-in flow also works, which is how the console calls this service from the browser.

Either way the organization comes from the credential. There is no organization parameter.

Responses
200

Every Brand in the organization. sections says which of the four carry prose, so a chooser can rank Brands without the listing becoming the brief.

Array of object
descriptionstringrequired
logoUrlstring | nullrequired

The Brand’s nominated logo, when it has one.

namestringrequired
sectionsobjectrequired

Which sections carry prose. An unwritten section is a normal state, not a deficit.

Show properties
guidelinesbooleanrequired
identitybooleanrequired
messagingbooleanrequired
voicebooleanrequired
slugstringrequired
401

No credential, or one that does not resolve. Send an API key or a session. See the security scheme. error is unauthorized.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:unauthorized
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

403

The caller does not hold brand:read. error is forbidden.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:forbidden
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

Request
curl -X GET "https://api.adcrunch.dev/context/brands/" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
[
  {
    "description": "string",
    "logoUrl": "string",
    "name": "string",
    "sections": {
      "guidelines": true,
      "identity": true,
      "messaging": true,
      "voice": true
    },
    "slug": "string"
  }
]