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.
Request
- Base URL: https://api.adcrunch.dev
- URL: https://api.adcrunch.dev/context/brands
- Auth: HTTP bearer
Query parameters
The nextCursor of the previous page. Omit it to get the first page. Send it with no change, and with the same filters as the request that answered it: a cursor from a different query gets a 400 invalid_cursor. Do not build or change a cursor.
The greatest number of rows on the page, from 1 to 500. The default is 100. A greater value gets a 400, with error of invalid_request.
Response
One 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.
Example response
{
"data": [
{
"description": "Running shoes sold direct to the runner, made to last a thousand kilometres.",
"logoUrl": "https://documents.adcrunch.dev/org_3a7f10/doc_5e2b41",
"name": "Acme",
"sections": {
"guidelines": true,
"identity": true,
"messaging": true,
"voice": true
},
"slug": "acme"
},
{
"description": "The trail range of Acme, sold to runners who leave the road.",
"logoUrl": null,
"name": "Acme Trail",
"sections": {
"guidelines": false,
"identity": true,
"messaging": false,
"voice": false
},
"slug": "acme-trail"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.