Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zendesk Custom Roles API

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

Zendesk Custom Roles API is one of 150 APIs that Zendesk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Custom Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against the base URL https://{subdomain}.zendesk.com.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{subdomain}.zendesk.com
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Roles 5
GET
/api/v2/custom_roles
Zendesk Get Api V2 Customroles
ListCustomRoles → 200
POST
/api/v2/custom_roles
Zendesk Post Api V2 Customroles
CreateCustomRole → 200
GET
/api/v2/custom_roles/{custom_role_id}
Zendesk Get Api V2 Customroles Customroleid
ShowCustomRoleById 1 param → 200
PUT
/api/v2/custom_roles/{custom_role_id}
Zendesk Put Api V2 Customroles Customroleid
UpdateCustomRoleById 1 param → 200
DELETE
/api/v2/custom_roles/{custom_role_id}
Zendesk Delete Api V2 Customroles Customroleid
DeleteCustomRoleById 1 param → 204

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are CustomRolesResponse (1 property), CustomRoleResponse (1 property). Each schema is shown below with its type and property counts.

CustomRoleResponse
object
1 property
CustomRolesResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendesk-custom-roles-api-openapi.yml Raw ↑

Other APIs Zendesk publishes across the network.

Zendesk Help Center Articles API
Zendesk Help Center Sections API
Zendesk Help Center Categories API
Zendesk Help Center Translations API
Zendesk Help Center Article Attachments API
Zendesk Help Center Article Comments API
Zendesk Help Center Article Labels API
Zendesk Help Center Topics API
Zendesk Help Center Posts API
Zendesk Help Center Post Comments API
Zendesk Help Center Votes API
Zendesk Help Center Content Subscriptions API