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

Get a Brand by slug

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

GET/context/brands/{slug}
Authorization
AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>.

Use an API key (acr_…), from the AdCrunch console under Settings → API keys.

The credential names the organization, and no operation takes an organization parameter.

See https://docs.adcrunch.dev/api/authentication.

Path parameters
slugstringrequired
Responses
200

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

assigneesobject[]required

The current members who are accountable for the record, oldest first, at most 10. An Assignee grants no access. A member who left is not listed.

Show properties
Array of object
idstringrequired

The usr_… id of the member.

namestringrequired

The name of the member.

bodystring | nullrequired

What an agent reads to act for this Brand, in markdown, or null when nobody wrote it. A listing answers hasBody, never the body.

createdAtnumberrequired

Milliseconds since the Unix epoch, UTC.

createdBystringrequired
descriptionstringrequired
idstringrequired
logoDocumentIdstring | nullrequired

The Document this Brand nominates as its logo.

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.

websiteUrlstring | nullrequired

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

400

The request does not match the schema of this operation: a field is missing or has the wrong type, or the body is not valid JSON. error is invalid_request, and issues names each field. Nothing was changed.

issuesobject[]required

One entry for each field that does not match.

Show properties
Array of object
instringrequired

The part of the request that holds the field.

Allowed:bodycookieheadersparamsquery
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.

pathstringrequired

A JSON Pointer into that part of the request, such as /filename. An empty string is the whole part.

errorstringrequired

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

Allowed:invalid_request
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.

401

No API key, or one that does not resolve. 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.

402

The organization has no active subscription. An owner subscribes at paywallUrl. error is organization_unentitled.

paywallUrlstring<uri>required

The page where an owner of the organization subscribes. Show it to the person.

errorstringrequired

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

Allowed:organization_unentitled
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.

Request
curl -X GET 'https://api.adcrunch.dev/context/brands/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "assignees": [
    {
      "id": "usr_4d8b12",
      "name": "Maya Lindqvist"
    }
  ],
  "body": "## Identity\n\nAcme makes one running shoe and sells it direct. The promise is a thousand kilometres on the same pair, and a resole rather than a replacement.\n\n## Voice\n\nPlain and measured. Short sentences. No superlative the shoe cannot earn.\n\n## Guidelines\n\n- Name the distance, never the \"journey\".\n- Claim the kilometres the shoe is tested to, and no more.\n- Do not compare the shoe to a named competitor.\n\n## Messaging\n\n- One shoe, a thousand kilometres.\n- Resole it twice, and keep running on it.\n- Sold direct, so the price is the cost of the shoe.",
  "createdAt": 1790000000000,
  "createdBy": "usr_4d8b12",
  "description": "Running shoes sold direct to the runner, made to last a thousand kilometres.",
  "id": "brd_6a9c33",
  "logoDocumentId": "doc_5e2b41",
  "name": "Acme",
  "revision": 4,
  "slug": "acme",
  "updatedAt": 1790086400000,
  "websiteUrl": "https://acme.example"
}