Sign in
Brands

List Brands

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

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

Example response

{
  "brands": [
    {
      "active": true,
      "brand_url": "https://brand1.com",
      "created_at": "2012-04-02T22:55:29Z",
      "default": true,
      "has_help_center": true,
      "help_center_state": "enabled",
      "host_mapping": "brand1.com",
      "id": 47,
      "logo": {
        "content_type": "image/png",
        "content_url": "https://company.zendesk.com/logos/brand1_logo.png",
        "file_name": "brand1_logo.png",
        "id": 928374,
        "size": 166144,
        "thumbnails": [
          {
            "content_type": "image/png",
            "content_url": "https://company.zendesk.com/photos/brand1_logo_thumb.png",
            "file_name": "brand1_logo_thumb.png",
            "id": 928375,
            "mapped_content_url": "https://company.com/photos/brand1_logo_thumb.png",
            "size": 58298,
            "url": "https://company.zendesk.com/api/v2/attachments/928375.json"
          },
          {
            "content_type": "image/png",
            "content_url": "https://company.zendesk.com/photos/brand1_logo_small.png",
            "file_name": "brand1_logo_small.png",
            "id": 928376,
            "mapped_content_url": "https://company.com/photos/brand1_logo_small.png",
            "size": 58298,
            "url": "https://company.zendesk.com/api/v2/attachments/928376.json"
          }
        ],
        "url": "https://company.zendesk.com/api/v2/attachments/928374.json"
      },
      "name": "Brand 1",
      "signature_template": "{{agent.signature}}",
      "subdomain": "brand1",
      "ticket_form_ids": [
        47,
        33,
        22
      ],
      "updated_at": "2012-04-02T22:55:29Z",
      "url": "https://company.zendesk.com/api/v2/brands/47.json"
    }
  ]
}

Changes