Custom Objects API
You can use the Custom Objects API to create, read, update, and delete objects that you define yourself. You can also use it to define and manage relationships with other objects, including native Zendesk objects like tickets and users.
The Custom Objects API consists of the following resources:
- Object Types
- Object Records
- Relationship Types
- Relationship Records
- Custom Objects Search
- Custom Objects Events
- Custom Objects Permissions
- Custom Objects Jobs
- Custom Objects Limits
Run in Postman
If you use Postman, you can import the Custom Objects 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:
If you don't use Postman, you can sign up for a free account on the Postman website and download the app.
The API path for custom objects is /api/sunshine/. Example:
This is the reference documentation for the Custom Objects API.
In addition to this API reference, the following resources are available in the Develop Help Center:
To get started, see Getting started with the Custom Objects API
For a concise developer guide, see the Custom objects handbook
To ask questions, provide answers, and join discussions, see the Custom Objects community
Enabling custom objects
Custom objects are available on the Enterprise plan. If you're interested in becoming a Zendesk developer partner, you can convert a trial account into a sponsored Zendesk Support account. The sponsored account is on the Enterprise plan with up to 5 agents. See Getting a trial or sponsored account for development in the Develop Help Center.
Custom objects must be enabled by an administrator in Zendesk Support. If you're not a Support admin, ask one to enable them for you.
To enable custom objects in your account
In Zendesk Support, click the Admin icon () in the sidebar, then select Manage > Custom Objects.
The Custom Objects page opens in Admin Center.
Click the Activate Custom Objects button.