This is the reference documentation for the Zendesk Chat API, which is also known as the Live Chat API.

Zendesk Chat is a live chat solution that helps businesses increase sales conversion by engaging important leads on their websites. It is our goal to help many of these businesses use the Zendesk Chat API (the "API") to automate and enhance their customer support with Zendesk Chat.

Run in Postman

If you use Postman, you can import the Chat Public API endpoints as a collection into your Postman app, then try out different requests to learn how the API works. Click the following button to get started:

Run in Postman

If you don't use Postman, you can sign up for a free account on the Postman website and download the app.

Document conventions

Endpoints are documented with the HTTP method for the request and a partial resource identifier. Example:

GET /api/v2/chats

Prepend https://www.zopim.com to the resource identifier to get the full endpoint URL. Example:

https://www.zopim.com/api/v2/chats

For more information on the syntax and style conventions used in the docs, see Documentation conventions in the general API introduction.

Security and authentication

This API is an SSL-only API, regardless of how you may have your account configured. You must be a Zendesk Chat user to make API requests.

If you created your Zendesk Chat account in Zendesk Support, you must authenticate with an OAuth access token. See OAuth access token.

If you have a stand-alone Chat account that wasn't created in Zendesk Support, you can use either basic authentication with your username and password credentials, or an OAuth access token.

If you aren't sure what type of Chat account you have, see Determining your Zendesk Chat account version.

Basic authentication

You can use basic authentication only if your Chat account was not created in Zendesk Support.

Use the following authentication format with your email address and password:

{email_address}:{password}

Example:

curl https://www.zopim.com/api/v2/agents/me \  -u [email protected]:password123

OAuth access token

The Zendesk Chat API supports OAuth authorization flows. See OAuth Authentication. In your requests, specify the access token in an Authorization header as follows:

Authorization: Bearer {access_token}

Example:

curl https://www.zopim.com/api/v2/agents/me \  -H "Authorization: Bearer gErypPlm4dOVgGRvA1ZzMH5MQ3nLo8bo"

For more information on the authentication required to use the APIs, see Security and authentication.

Rate limiting

Each endpoint in the Chat API is rate limited at 200 requests per minute. The response includes headers indicating the account's current rate limit and the number of requests remaining in the current minute:

X-RateLimit: 200X-RateLimit-Remaining: 199

If the rate limit is exceeded, Zendesk Chat will respond with a HTTP 429 Too Many Requests response code and a body that details the reason for the rate limiter kicking in.

Request format

The request paths of the Chat API don't specify an account subdomain like the Support, Help Center, or Talk APIs. The path uses https://www.zopim.com with the resource identifier. Example:

curl https://www.zopim.com/api/v2/chats \  -H "Authorization: Bearer gErypPlm4dOVgGRvA1ZzMH5MQ3nLo8bo"

For general information on requests, see Requests in the general API introduction.

Response format

For information on the HTTP status codes returned by the API, see Response format in the general API introduction.