Introduction
Custom objects are part of the Support API that enable you to extend the Zendesk data model and bring in data unique to your business so that you can model your business within Zendesk. 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 standard Zendesk objects such as tickets and users.
You can think of a custom object as a container with a schema or data model defined by custom fields. After the custom object is created, admins can make them available to users to add data into, such as in a ticket or form. Every time an agent uses the custom object to add data to Zendesk, a new record is created.
Run in Postman
If you use Postman, you can import the Support 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:
If you don't use Postman, you can sign up for a free account on the Postman website and download the app. For more information about using Postman with Zendesk APIs, see Exploring Zendesk APIs with Postman.
Plan availability
The Custom Objects API is available on Support Enterprise plans and Zendesk Suite Team plans and above.
Limitations
Custom object limitations
Only admins can create custom objects. The maximum number of custom objects and fields per custom object vary by plan:
| Suite Team | Suite Growth | Suite Professional | Support Enterprise | Suite Enterprise | Suite Enterprise Plus | |
|---|---|---|---|---|---|---|
| Custom objects | 3 | 5 | 30 | 30 | 50 | 50 |
| Fields per object | 100 | 100 | 100 | 100 | 100 | 100 |
| Lookup fields per object | 5 | 5 | 10 | 10 | 10 | 10 |
Custom object records limitations
- Each record can be a maximum of 32 KB in size.
- Custom object records are counted toward your account's storage.
- Regardless of the storage capacity, accounts can't exceed 50 million custom object records.
- Light agents and contributors have view-only access to custom object records.
Documentation conventions
For information on the syntax and style conventions used in the docs, see Documentation conventions in the general API introduction.
Security and authentication
For information on the authentication required to use the API, see Security and authentication in the general API introduction.
Rate limits
For information on the number of requests allowed per minute, see Rate limits in the general API introduction.
Request format
For 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.
Data types
For information on data types used in the API, see Data types in the general API introduction.
Pagination
For information on paginating through list endpoints, see Pagination in the general API introduction.