Zendesk

Zendesk Brand Agents API

The Zendesk Brand Agents API lets you programmatically manage which agents have access to which brands in a multibrand Zendesk Support account. It provides endpoints to list the agents associated with a given brand and to add or remove agents from that brand, so you can automate onboarding/offboarding, sync brand access from external directories, and enforce leastprivilege access at scale.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/brand_agents/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/openapi/brand-agents-openapi-original.yml

OpenAPI Specification

brand-agents-openapi-original.yml Raw ↑ 
openapi: 3.1.0
info:
  version: "1.0"
  title: Zendesk Brand Agents
  description: Needs a description.
paths:
  /api/v2/brand_agents:
    get:
      operationId: ListBrandAgents
      tags:
        - Brand Agents
      summary: Zendesk Get  Api V2 Brand_agents
      description: |
        Returns a list of all brand agent memberships for your account.


        #### Pagination

        * Cursor pagination (recommended)
        * Offset pagination

        See [Pagination](/api-reference/introduction/pagination/).

        Returns a maximum of 100 records per page.

        #### Allowed For:

        * Admins
      parameters:
        - $ref: '#/components/parameters/UserId'
        - $ref: '#/components/parameters/BrandId'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandAgentsResponse'
              examples:
                default:
                  $ref: '#/components/examples/BrandAgentsResponseExample'
  /api/v2/brand_agents/{brand_agent_id}:
    get:
      operationId: ShowBrandAgentById
      tags:
        - Brand Agents
      summary: Zendesk Get  Api V2 Brand_agents Brand_agent_id
      description: |
        Returns a brand agent membership for your account.


        #### Allowed For

        * Admins
      parameters:
        - $ref: '#/components/parameters/BrandAgentId'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandAgentResponse'
              examples:
                default:
                  $ref: '#/components/examples/BrandAgentResponseExample'
components:
  schemas:
    BrandAgentsResponse:
      type: object
      properties:
        brand_agents:
          type: array
          items:
            $ref: '#/components/schemas/BrandAgentObject'
    BrandAgentResponse:
      type: object
      properties:
        brand_agent:
          $ref: '#/components/schemas/BrandAgentObject'
tags:
  - name: Brand Agents