DocumentationAPI Reference

Develop on the Zendesk Sunshine Platform

Zendesk Sunshine is our open and flexible platform, built natively on AWS. You can create unique customer experiences using our APIs and SDKs, connect data sources across your technology stack, and build any app or automation you want, using the languages you love.
Blocks and a ruler representing a graph

Create a developer account

Try out the Sunshine Platform with a free, 14-day trial account.

Create an account

Create your first ticket

Get up and running on the Sunshine Platform using this 10-minute API quickstart guide.

Get started

Explore the Zendesk APIs

Use Postman, a popular API testing tool, to explore the Zendesk APIs.

Explore the APIs
A person looking at a phone screen
A customer ordering flowers from a customer service agent within a messaging conversation

Deliver rich conversational experiences

Use our Zendesk SDKs to add messaging to your web, mobile, and social channels so customers can reach you instantly.

Use the Web Widget API to configure the Web Widget settings and customize its appearance and functionality.

Web Widget API reference
New to messaging? Learn more about Messaging

Guides to solve your problems

Access, integrate, and extend your data anywhere with an event-driven platform and robust APIs that let you build anything—inside or outside of Zendesk.
A conversation thread within a support ticket between a customer and support agent
A help center article showing information about clothing sizes
A caller's profile image and phone number, with an option accept the incoming call
An app extending the functionality of Zendesk's Sales CRM
A customer chatting to a customer service agents requesting to change the size of the boquet they ordered

Ticketing system

Build custom ticket forms, create tickets programmatically and learn how to use our APIs to work with tickets.

Overview
A conversation thread within a support ticket between a customer and support agent
A help center article showing information about clothing sizes
A caller's profile image and phone number, with an option accept the incoming call
An app extending the functionality of Zendesk's Sales CRM
A customer chatting to a customer service agents requesting to change the size of the boquet they ordered

Connect all of your customer data

Sunshine helps you connect all your customer data for complete context—wherever it lives—and use our tools to build the best customer experiences.
Data from external sources linked to an individual's profile in Zendesk
An person's profile extended with additional information from other connected platforms
A timeline of a customer activity used to help provide them with customer support

Store and connect new data sources, like products and order history, for greater context about your customers.

Getting started with custom objects
Data from external sources linked to an individual's profile in Zendesk
An person's profile extended with additional information from other connected platforms
A timeline of a customer activity used to help provide them with customer support

Build apps with any tech

Zendesk apps are installed in the agent interface that extends the functionality of the Sunshine Platform. We've got the tools and frameworks to help you get started.

Learn how the Zendesk Apps framework (ZAF) lets you build integrations and custom features to extend the functionality of Sunshine.

App developer guide

Read the API Reference

Zendesk's APIs are organized around REST principles. Our APIs have resource-oriented URLs, accepts form-encoded request bodies and return JSON-encoded responses.
Read the API Reference
A code block showing the response from a ticket creation endpoint