Documentation API Reference

Integration Services

This is the reference documentation for the Zendesk Integration Services (ZIS) APIs. It documents the REST APIs you can use to build and run an integration using ZIS. The ZIS APIs power Conversational Data Orchestration.

ZIS APIs are available on Suite Growth and above and Support Professional and above. If you're interested in becoming a Zendesk developer partner, you can convert a trial account into a sponsored Zendesk account. SeeGetting a trial or sponsored account for development.

Document conventions

For information on the syntax and style conventions used, seeDocumentation conventionsin the general API introduction.

Examples

For information on the curl examples used in the APIs, seeExamplesin the general API introduction.

Security and authentication

ZIS APIs use OAuth 2.0 for authenticating requests, unless stated otherwise. The OAuth access token must be associated with the ZIS integration specified in the request. To get this token, seeObtaining a ZIS OAuth token.

Some endpoints support other authentication methods, including:

  • Basic authentication
  • API token
  • Browser session authentication in a Zendesk app

如果支持,这些身份验证methods are noted in the endpoint's documentation. For more information about basic authentication and API tokens, seeSecurity and authenticationin the general API introduction. For more information about browser session authentication, seeMaking API requests from a Zendesk app.

Rate limits

The following API rate limits apply:

If a rate limit is exceeded, the API responds with an HTTP 429 Too Many Requests status code.

For more information on the number of requests allowed per minute, seeRate limitsin the general API introduction.

Request format

For information on the JSON request format, seeRequest formatin the general API introduction.

Response format

For information on the HTTP status codes returned by these APIs, seeResponse formatin the general API introduction.

Pagination

For information on paginating through list endpoints, seePaginationin the general API introduction.

Data types

For information on data types returned by the APIs, seeData typesin the general API introduction.