Zendesk

Zendesk Assignables API

The Zendesk Assignables API lets you find out who or what can be assigned to a piece of worktypically a ticketgiven your accounts permissions, groups, and routing rules. It returns the set of eligible assignees (such as agents or groups) for a particular context, so you can build assignee pickers in custom apps, validate that an assignment is allowed before updating a ticket, or automate routing workflows.

Documentation GitHub OpenAPI

Documentation

📖

Documentation

https://developer.zendesk.com/api-reference/ticketing/introduction/

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/openapi/assignables-openapi-original.yml

OpenAPI Specification

openapi: 3.1.0
info:
  version: "1.0"
  title: Zendesk Assignables
  description: Needs a description.
paths:
  /api/lotus/assignables/autocomplete.json:
    get:
      operationId: ListAssigneeFieldAssignableGroupsAndAgentsSearch
      tags:
        - AssigneeFieldAssignableAgents
        - AssigneeFieldAssignableGroups
      summary: Zendesk Get  Api Lotus Assignables Autocomplete.json
      description: |
        List assignable groups and agents based on query matched against name

        #### Allowed For

        * Agents
      parameters:
        - $ref: '#/components/parameters/AssigneeFieldSearchValue'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AssigneeFieldAssignableGroupsAndAgentsSearchResponse
              examples:
                default:
                  $ref: >-
                    #/components/examples/AssigneeFieldAssignableGroupsAndAgentsSearchResponseExample
  /api/lotus/assignables/groups.json:
    get:
      operationId: ListAssigneeFieldAssignableGroups
      tags:
        - AssigneeFieldAssignableAgents
      summary: Zendesk Get  Api Lotus Assignables Groups.json
      description: |
        List assignable groups on the AssigneeField

        #### Allowed For

        * Agents
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssigneeFieldAssignableGroupsResponse'
              examples:
                default:
                  $ref: >-
                    #/components/examples/AssigneeFieldAssignableGroupsResponseExample
  /api/lotus/assignables/groups/{group_id}/agents.json:
    get:
      operationId: ListAssigneeFieldAssignableGroupAgents
      tags:
        - AssigneeFieldAssignableAgents
      summary: Zendesk Get  Api Lotus Assignables Groups Group_id Agents.json
      description: |
        List assignable agents from a group on the AssigneeField

        #### Allowed For

        * Agents
      parameters:
        - $ref: '#/components/parameters/GroupId'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AssigneeFieldAssignableGroupAgentsResponse
              examples:
                default:
                  $ref: >-
                    #/components/examples/AssigneeFieldAssignableGroupAgentsResponseExample
components:
  schemas:
    AssigneeFieldAssignableGroupsAndAgentsSearchResponse:
      type: object
      properties:
        agents:
          type: array
          items:
            $ref: '#/components/schemas/AssigneeFieldAssignableSearchAgentObject'
        count:
          type: integer
          description: Number of agents + groups listed from search result.
        groups:
          type: array
          items:
            $ref: '#/components/schemas/AssigneeFieldAssignableSearchGroupObject'
      example:
        agents:
          - group: Tech
            group_id: 6574839201
            id: 8392017465
            name: Sam Technologist
            photo_url: >-
              https://z3n-example.zendesk.com/system/photos/410305192023/my_profile.png
        count: 2
        groups:
          - id: 6574839201
            name: Tech
    AssigneeFieldAssignableGroupsResponse:
      type: object
      properties:
        count:
          type: integer
          description: Number of groups listed in `groups` property.
        groups:
          type: array
          items:
            $ref: '#/components/schemas/AssigneeFieldAssignableGroupObject'
        next_page:
          type: string
          nullable: true
          readOnly: true
        previous_page:
          type: string
          nullable: true
          readOnly: true
      example:
        count: 3
        groups:
          - description: Engineering
            id: 9182736455
            name: Group for Bugs for Engineering
          - description: Product
            id: 1928374655
            name: Group for feature requests
          - description: Customer Support
            id: 5519283746
            name: Group for customer inquiries
        next_page:
        previous_page:
    AssigneeFieldAssignableGroupAgentsResponse:
      type: object
      properties:
        agents:
          type: array
          items:
            $ref: '#/components/schemas/AssigneeFieldAssignableAgentObject'
        count:
          type: integer
          description: Number of agents listed in `agents` property.
        next_page:
          type: string
          nullable: true
          readOnly: true
        previous_page:
          type: string
          nullable: true
          readOnly: true
      example:
        agents:
          - avatar_url: >-
              https://z3n-example.zendesk.com/system/photos/900005192023/my_profile.png
            id: 6473829100
            name: Joe Smith
          - avatar_url: >-
              https://z3n-example.zendesk.com/system/photos/412005192023/my_profile.png
            id: 9182736400
            name: Jane Doe
          - avatar_url: >-
              https://z3n-example.zendesk.com/system/photos/887005192023/my_profile.png
            id: 1928373460
            name: Cookie Monster
        count: 3
        next_page:
        previous_page:
tags:
  - name: AssigneeFieldAssignableAgents
  - name: AssigneeFieldAssignableGroups