Help Center API

General

The Help Center API is part of the Zendesk v2 API. Any general mechanisms and conventions, such as pagination and authentication, work as described in the Zendesk v2 API documentation and are considered implied in this text.

Responses are always filtered according to the permissions of the user on whose behalf the API request is made. For example, when the user requests a list of articles in a section, the API returns only the articles the user can view in Help Center.

The API deals only with Help Center items. For example, comments can be made on both articles and requests, but the Help Center API only provides access to article comments. This means that an endpoint that returns "all comments made by a user" actually returns "all comments made on Help Center articles by a user."

Data types

  • The documentation specifies using integers for IDs in the API. The term refers to the JSON numeric type, not a C-like int data type. Zendesk recommends using the string type for IDs in Help Center.

  • Locales are returned and passed as strings. Example: 'en-us'.

  • Time stamps are in the ISO 8601 format. Example: '2015-04-16T09:14:57Z'.

Rate limits

This Help Center API is rate limited. Only a certain number of requests are allowed per minute. Zendesk reserves the right to adjust the rate limit for given endpoints to provide a high quality of service for all clients.

The Help Center API follows the Support API's requests-per-minute limits. See Rate Limits in the Support API. Requests in one API don't count against the rate limit of the other API.

If the rate limit is exceeded, Zendesk responds with an HTTP 429 Too Many Requests response code and a body that details the reason for the rate limiter kicking in. The response has a Retry-After header that tells you how many seconds to wait before trying again. You can use the information in your API client to handle errors. See Best practices for avoiding rate limiting.