DocumentationAPI Reference

Zendesk QA

This is the reference documentation for the Zendesk QA public API. You can use the API to import users and tickets into Zendesk QA, and to export data from Zendesk QA.

Any general mechanisms and conventions, such as pagination and authentication, work as described in the Zendesk API introduction and are considered implied in this text.

Authentication

All endpoints require authentication with a bearer token in the Authorization header.

Rate limits

  • API import comment limit: 500 comments per ticket
  • API import limit: 100 tickets per import
  • API request limit: 1,500 requests per minute per IP

Request and response format

The Export API is a gRPC-Gateway service. It represents int64 fields as JSON strings and returns errors in the rpcStatus format. The Import API uses a custom HTTP handler. It parses requests with protojson, which accepts int64 values as strings or numbers. It encodes responses with the standard encoding/json package, which represents int64 fields as numbers.