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

brand_list

List your organization's brands as slug + name + description, so an agent can pick one before loading its context.

Lists the Brands of your organization, newest first, as slug, name and description. The brand context itself is not returned — pick one here, then load it with brand_get.

That split is deliberate: brand context is prose, and returning all of it for every brand would crowd out the rest of the conversation.

Input

Field Type Required Description
limit number no The greatest number of rows in the answer, from 1 to 500. The default is 100.
cursor string no The nextCursor of the previous answer. Omit it to get the first page.

Output

{ brands: [...], nextCursor? }. Each brand is { slug, name, description }. Deleted brands are excluded. When nextCursor is present, more brands exist: call brand_list again with cursor set to that value.

Example

“Which brands do we have set up?”

brand_list({});
// → { brands: [{ slug: 'acme-running', name: 'Acme Running', description: 'DTC running shoes.' }] }

Errors

  • invalid_cursor — the cursor is not a nextCursor of this tool, with the same arguments. Send it with no change, or omit it.

Requires the brand:read scope.

Was this page helpful?