BObotbrains-io
Brands

List Brands

Changed on

Returns a list of all brands for your account sorted by name.

Allowed for

  • Admins
  • Agents with the assign_tickets_to_any_brand permission can list all brands for the account
  • Agents without the assign_tickets_to_any_brand permission can only list brands they are members of

Pagination

  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.

get/api/v2/brands

Request

Query parameters

page[before]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[after]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[size]integer

Specifies how many records should be returned in the response. You can specify up to 100 records per page.

Response

Successful response

countinteger

the total record count

next_pagestring url nullable

the URL of the next page

previous_pagestring url nullable

the URL of the previous page

Changes

  • 4085d8c72c5cRevision changes
    • breaking

      the //////// response's property type changed from string to integer for status

    • breaking

      the //////// response's property type changed from string to integer for status

    • breaking

      the ////////// response's property type changed from string to integer for status

    • breaking

      the ////////// response's property type changed from string to integer for status

  • 4799eea0d139Revision changes
    • breaking

      the //////// response's property type changed from integer to string for status

    • breaking

      the //////// response's property type changed from integer to string for status

    • breaking

      the ////////// response's property type changed from integer to string for status

    • breaking

      the ////////// response's property type changed from integer to string for status