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 Requests API

The Requests API from Zendesk — 5 operation(s) for requests.

Zendesk Requests 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 Requests. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

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

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

7 operations 5 paths 4 schemas 5 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 7

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

Requests 7
GET
/api/v2/requests
Zendesk Get Api V2 Requests
ListRequests 2 params → 200
POST
/api/v2/requests
Zendesk Post Api V2 Requests
CreateRequest → 201
GET
/api/v2/requests/{request_id}
Zendesk Get Api V2 Requests Requestid
ShowRequest 1 param → 200
PUT
/api/v2/requests/{request_id}
Zendesk Put Api V2 Requests Requestid
UpdateRequest 1 param → 200
GET
/api/v2/requests/{request_id}/comments
Zendesk Get Api V2 Requests Requestid Comments
ListComments 3 params → 200
GET
/api/v2/requests/{request_id}/comments/{ticket_comment_id}
Zendesk Get Api V2 Requests Requestid Comments Ticketcommentid
ShowComment 2 params → 200
GET
/api/v2/requests/search
Zendesk Get Api V2 Requests Search
SearchRequests 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are RequestResponse (1 property), TicketCommentResponse (1 property), TicketCommentsResponse (1 property), RequestsResponse (1 property). Each schema is shown below with its type and property counts.

RequestsResponse
object
1 property
TicketCommentsResponse
object
1 property
TicketCommentResponse
object
1 property
RequestResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendesk-requests-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