v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Brand

brand.list

Lists all brands for the organization.

Requires the organizationRead permission.

post/brand.list

Request body

cursorstring nullable

The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.

limitinteger nullable

The maximum number of brands to return per page. Maximum is 100.

Example request

{
  "cursor": "G8",
  "limit": 25
}

Response

Responses from the brand.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "3ae2b801-19f6-41ef-ad28-214bd731948f",
      "name": "Acme",
      "hostedJobsPageSlug": "acme"
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}