Zendesk Incremental Export 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 Incremental Export. 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 7 paths,
and defines 6 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 operations7 paths6 schemas7 GET
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 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.
Incremental Export 7
GET
/api/v2/incremental/{incremental_resource}/sample
Zendesk Get Api V2 Incremental Incrementalresource Sample
IncrementalSampleExport2 params→ 200
GET
/api/v2/incremental/organizations
Zendesk Get Api V2 Incremental Organizations
IncrementalOrganizationExport2 params→ 200
GET
/api/v2/incremental/ticket_events
Zendesk Get Api V2 Incremental Ticketevents
IncrementalTicketEvents1 param→ 200
GET
/api/v2/incremental/tickets
Zendesk Get Api V2 Incremental Tickets
IncrementalTicketExportTime1 param→ 200
GET
/api/v2/incremental/tickets/cursor
Zendesk Get Api V2 Incremental Tickets Cursor
IncrementalTicketExportCursor2 params→ 200
GET
/api/v2/incremental/users
Zendesk Get Api V2 Incremental Users
IncrementalUserExportTime2 params→ 200
GET
/api/v2/incremental/users/cursor
Zendesk Get Api V2 Incremental Users Cursor
IncrementalUserExportCursor3 params→ 200
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CursorBasedExportIncrementalUsersResponse (6 properties), CursorBasedExportIncrementalTicketsResponse (6 properties), TimeBasedExportIncrementalTicketsResponse (5 properties), ExportIncrementalOrganizationsResponse (5 properties). Each schema is shown below with its type and property counts.
ExportIncrementalTicketEventsResponse
object
5 properties
CursorBasedExportIncrementalTicketsResponse
object
See [Tickets](/api-reference/ticketing/tickets/tickets/) for a detailed example.
6 properties
TimeBasedExportIncrementalUsersResponse
object
5 properties
ExportIncrementalOrganizationsResponse
object
5 properties
CursorBasedExportIncrementalUsersResponse
object
6 properties
TimeBasedExportIncrementalTicketsResponse
object
See [Tickets](/api-reference/ticketing/tickets/tickets/) for a detailed example.
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
