Skip to content
AdCrunch
Esc
↑↓navigate↵open⌘Jpreview

Get a Brand by slug

Reads one Brand by its slug. The answer has every narrative section and the current revision. Send that revision back as base_revision when you update the Brand. A section that nobody wrote is null.

GET/context/brands/{slug}
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.

Path parameters
slugstringrequired
Responses
200

The Brand with all four sections. It does not carry its Personas — ask GET /context/brands/{slug}/personas/ for those.

createdAtnumberrequired

Milliseconds since the Unix epoch, UTC.

createdBystringrequired
descriptionstringrequired
guidelinesstring | nullrequired

Do’s and don’ts, claims to avoid.

idstringrequired
identitystring | nullrequired

Positioning, mission, what is on offer.

logoDocumentIdstring | nullrequired

The Document this Brand nominates as its logo.

messagingstring | nullrequired

Key messages, value propositions, proof points.

namestringrequired
revisionnumberrequired

Increments on every write. Send it back as base_revision to edit; a stale one answers 409.

slugstringrequired
updatedAtnumber | nullrequired

Milliseconds since the Unix epoch, UTC.

voicestring | nullrequired

Tone and personality.

websiteUrlstring | nullrequired

The brand’s public site. A locator only — its contents are not stored.

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.

404

No Brand with that slug in this organization. error is not_found.

errorstringrequired

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

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.

422

The request did not match this operation’s schema. This is the framework’s own shape, not the error/message one.

errorsobject[]required

One entry per failing field.

foundanyrequired

What was sent.

messagestringrequired
onstringrequired

Which part of the request failed: body, query or params.

propertystringrequired

The field that failed.

typestringrequired
Allowed:validation
Request
curl -X GET "https://api.adcrunch.dev/context/brands/string" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "createdAt": 0,
  "createdBy": "string",
  "description": "string",
  "guidelines": "string",
  "id": "string",
  "identity": "string",
  "logoDocumentId": "string",
  "messaging": "string",
  "name": "string",
  "revision": 0,
  "slug": "string",
  "updatedAt": 0,
  "voice": "string",
  "websiteUrl": "string"
}