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

Get a Persona

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

GET/context/brands/{slug}/personas/{personaSlug}
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
personaSlugstringrequired
slugstringrequired
Responses
200

The Persona with all four sections.

ageMaxnumber | nullrequired
ageMinnumber | nullrequired

Each bound is independently optional, so "35+" is expressible.

brandIdstringrequired
createdAtnumberrequired

Milliseconds since the Unix epoch, UTC.

createdBystringrequired
descriptionstringrequired
frictionsstring | nullrequired

Objections, doubts, what stops them.

idstringrequired
languagestring | nullrequired

The words they use for the problem, in their own register. Not a locale, despite the name.

motivationsstring | nullrequired

What they want, and what triggers them.

namestringrequired
profilestring | nullrequired

Who they are, and their situation.

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.

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 such Brand, or no Persona with that slug inside it. error is not_found either way — the two are deliberately not told apart.

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/personas/string" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "ageMax": 0,
  "ageMin": 0,
  "brandId": "string",
  "createdAt": 0,
  "createdBy": "string",
  "description": "string",
  "frictions": "string",
  "id": "string",
  "language": "string",
  "motivations": "string",
  "name": "string",
  "profile": "string",
  "revision": 0,
  "slug": "string",
  "updatedAt": 0
}