API Reference

Zendesk’s APIs are organized around REST. Our APIs have predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

如果你是新的REST api,看看theZendesk API quick start and theREST API glossary.

Run in Postman

To quickly get started with the Zendesk APIs, you can use the Zendesk Public Workspace on Postman. The collection includes all Zendesk APIs except the Sell and Sunshine Conversations APIs.

Run in Postman

Capabilities

票务

Work with tickets, users and organizations and manage ticket workflows.

Support API JIRA Integration API

Help Center

Help Center, Knowledge base and Community.

Help Center API

Live Chat

Live chat and messaging.

Chat API Real Time Chat API Chat Conversations API

Voice

Call center software.

Talk API Talk Partner Edition API

Sales CRM

Sales force automation.

Sell API Sync API Firehose API Search API

Custom data

Connect and understand all your customer data wherever it lives.

Custom Objects API Profiles API Events API

Conversations

Unify messages from every channel into a single conversation and build interactive experiences.

Conversations API

Omnichannel

Access features and functionality that span Zendesk channels.

Omnichannel APIs

Status

Get a list of active incidents and scheduled maintenance that may affect Zendesk availability.

Status API

Embedding Zendesk

Web Widget (Classic)

Control data passed to and from the Web Widget (Classic)

Web Widget (Classic) API

Answer Bot

Provide Help Center article suggestions for an enquiry.

Answer Bot API

Extending Zendesk

Apps

APIs to help you build apps for Zendesk Support, Sell and Chat

Apps Core API Apps Support API Apps Sell API Apps Chat API

Integration Services

APIs and trigger events information for building integrations with Zendesk Integration Services (ZIS)

ZIS Configs API Connections API ZIS Inbound Webhooks API ZIS Links API ZIS Registry API Trigger events reference