Zendesk

Zendesk Custom Roles API

The Custom Roles API from Zendesk — 2 operation(s) for custom roles.

Documentation GitHub OpenAPI

Business capability

Identity & Access Management BC-620.20

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v2/custom_roles List custom agent roles · Zendesk Get Api V2 Custom_roles #

Ask an LLM

“What custom roles are defined for agents?”

“Are custom roles only on the Enterprise plan?”

Tell an agent

List all custom agent roles.

Show the custom roles in my account.

POST /api/v2/custom_roles Create a custom agent role · Zendesk Post Api V2 Custom_roles #

Ask an LLM

“Can I create a role with limited permissions for contractors?”

“Which agents are allowed to create custom roles?”

Tell an agent

Create a custom role for contractors.

Add a new agent role that can only view tickets.

GET /api/v2/custom_roles/{custom_role_id} Get a custom role · Zendesk Get Api V2 Custom_roles Custom_role_id #

Ask an LLM

“Where can I see the permissions of one custom role?”

“Can I look up a single agent role's configuration?”

Tell an agent

Show this custom role.

Get the permissions of the contractor role.

PUT /api/v2/custom_roles/{custom_role_id} Update a custom role · Zendesk Put Api V2 Custom_roles Custom_role_id #

Ask an LLM

“Can I change the permissions of an existing custom role?”

“Does manage_roles permission let an agent edit roles?”

Tell an agent

Update this custom role's permissions.

Allow the contractor role to edit ticket tags.

DELETE /api/v2/custom_roles/{custom_role_id} Delete a custom role · Zendesk Delete Api V2 Custom_roles Custom_role_id #

Ask an LLM

“Can I remove a custom role we no longer use?”

“Who is allowed to delete a custom agent role?”

Tell an agent destructive · confirm first

Delete this custom role.

Remove the old contractor role.

Documentation

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

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

https://developer.zendesk.com/api-reference/sales-crm/resources/account/

https://developer.zendesk.com/api-reference/ticketing/tickets/activity_stream/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/channel_framework/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/audit_logs/

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

https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/bookmarks/

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

https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/

https://developer.zendesk.com/api-reference/live-chat/chat-api/chats/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/

https://developer.zendesk.com/api-reference/custom-data/introduction/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/

https://developer.zendesk.com/api-reference/ticketing/tickets/custom_ticket_statuses/

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

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

https://developer.zendesk.com/api-reference/ticketing/business-rules/deletion_schedules/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/

https://developer.zendesk.com/api-reference/ticketing/tickets/email_notifications/

https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/

https://developer.zendesk.com/api-reference/ticketing/business-rules/group_sla_policies/

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

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_import/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/

https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/

https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/

https://developer.zendesk.com/api-reference/ticketing/organizations/organization_subscriptions/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/push_notification_devices/

https://developer.zendesk.com/api-reference/agent-availability/omnichannel_routing_queues/omnichannel_routing_queues/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/support_addresses/

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

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-requests/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/resource_collections/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/skill_based_routing/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_reasons/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/

https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/

https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_skips/

https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/

https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_audits/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_form_statuses/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_metrics/

https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/

https://developer.zendesk.com/api-reference/ticketing/business-rules/views/

https://developer.zendesk.com/api-reference/ticketing/ticket-management/workspaces/

Specifications

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

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/json-schema/zendesk-ticket-schema.json

https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/json-schema/zendesk-user-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/json-ld/zendesk-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/zendesk:zendesk-custom-roles-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: '1.0'
  title: Zendesk Custom Roles API
  description: Needs a description.
tags:
- name: Custom Roles
paths:
  /api/v2/custom_roles:
    get:
      operationId: ListCustomRoles
      tags:
      - Custom Roles
      summary: Zendesk Get Api V2 Custom_roles
      description: '#### Availability


        * Accounts on the Enterprise plan or above


        #### Allowed For


        * Agents'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomRolesResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomRolesResponseExample'
    post:
      operationId: CreateCustomRole
      tags:
      - Custom Roles
      summary: Zendesk Post Api V2 Custom_roles
      description: '#### Availability


        * Accounts on the Enterprise plan or above


        #### Allowed for


        * Administrators

        * Agents with the `manage_roles` permission'
      responses:
        '200':
          description: Created response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomRoleResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomRoleResponseExample'
  /api/v2/custom_roles/{custom_role_id}:
    parameters:
    - $ref: '#/components/parameters/CustomRoleId'
    get:
      operationId: ShowCustomRoleById
      tags:
      - Custom Roles
      summary: Zendesk Get Api V2 Custom_roles Custom_role_id
      description: '#### Availability


        * Accounts on the Enterprise plan or above


        #### Allowed for


        * Administrators

        * Agents with the `manage_roles` permission'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomRoleResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomRoleResponseExample'
    put:
      operationId: UpdateCustomRoleById
      tags:
      - Custom Roles
      summary: Zendesk Put Api V2 Custom_roles Custom_role_id
      description: '#### Availability


        * Accounts on the Enterprise plan or above


        #### Allowed for


        * Administrators

        Agents with the `manage_roles` permission'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomRoleResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomRoleResponseExample'
    delete:
      operationId: DeleteCustomRoleById
      tags:
      - Custom Roles
      summary: Zendesk Delete Api V2 Custom_roles Custom_role_id
      description: '#### Availability


        * Accounts on the Enterprise plan or above


        #### Allowed for


        * Administrators

        * Agents with the `manage_roles` permission'
      responses:
        '204':
          description: No Contetnt response
components:
  schemas:
    CustomRolesResponse:
      type: object
      properties:
        custom_roles:
          type: array
          items:
            $ref: '#/components/schemas/CustomRoleObject'
    CustomRoleResponse:
      type: object
      properties:
        custom_role:
          $ref: '#/components/schemas/CustomRoleObject'