List the Brands
Lists the Brands of your organization, newest first. 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.
One page at a time: limit rows at most, 100 by default. When the answer holds nextCursor, more rows exist: send it back as cursor to get the next page.
/context/brandsAuthorizationBearer token · headerrequiredSend 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.
cursorstringlimitintegerrequiredOne page of the Brands of the organization, newest first. sections says which of the four carry prose, so a chooser can rank Brands without the listing becoming the brief. logoUrl is the public address of the Document the Brand nominates, and it is null when it nominates none. This page is the last one, so it carries no nextCursor.
dataobject[]requiredShow propertiesHide properties
objectdescriptionstringrequiredlogoUrlstring | nullrequiredThe Brand’s nominated logo, when it has one.
namestringrequiredsectionsobjectrequiredWhich sections carry prose. An unwritten section is a normal state, not a deficit.
Show propertiesHide properties
guidelinesbooleanrequiredidentitybooleanrequiredmessagingbooleanrequiredvoicebooleanrequiredslugstringrequirednextCursorstringSend this value as cursor to get the next page. It is absent on the last page.
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. Or AdCrunch cannot use the cursor: it cannot read it, or the cursor belongs to a different query. Then error is invalid_cursor. Send the nextCursor of the previous page with no change, or omit cursor to get the first page.
issuesobject[]requiredOne entry for each field that does not match.
Show propertiesHide properties
objectinstringrequiredThe part of the request that holds the field.
bodycookieheadersparamsquerymessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
pathstringrequiredA JSON Pointer into that part of the request, such as /filename. An empty string is the whole part.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
invalid_requestmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
invalid_cursormessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
No API key, or one that does not resolve. See the security scheme. error is unauthorized.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
unauthorizedmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.
The caller does not hold brand:read. error is forbidden.
errorstringrequiredA stable code for the failure. This is the field to branch on. It does not change for a given failure.
forbiddenmessagestringrequiredA sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.