Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zendesk Custom Object Records API

The Custom Object Records API from Zendesk — 7 operation(s) for custom object records.

Zendesk Custom Object Records API is one of 150 APIs that Zendesk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Custom Object Records. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 13 operations across 7 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against the base URL https://{subdomain}.zendesk.com.

13 operations 7 paths 3 schemas 2 DELETE6 GET2 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{subdomain}.zendesk.com
Resource Areas
1

Paths & Operations 13

Across 7 paths, the API surfaces 13 operations — 2 DELETE, 6 GET, 2 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Object Records 13
GET
/api/v2/custom_objects/{custom_object_key}/records/autocomplete
Zendesk Get Api V2 Customobjects Customobjectkey Records Autocomplete
AutocompleteCustomObjectRecordSearch 11 params → 200
POST
/api/v2/custom_objects/{custom_object_key}/jobs
Zendesk Post Api V2 Customobjects Customobjectkey Jobs
CustomObjectRecordBulkJobs 1 param body → 201
GET
/api/v2/custom_objects/{custom_object_key}/records
Zendesk Get Api V2 Customobjects Customobjectkey Records
ListCustomObjectRecords 7 params → 200
POST
/api/v2/custom_objects/{custom_object_key}/records
Zendesk Post Api V2 Customobjects Customobjectkey Records
CreateCustomObjectRecord 1 param body → 201
PATCH
/api/v2/custom_objects/{custom_object_key}/records
Zendesk Patch Api V2 Customobjects Customobjectkey Records
UpsertCustomObjectRecordByExternalIdOrName 3 params body → 200
DELETE
/api/v2/custom_objects/{custom_object_key}/records
Zendesk Delete Api V2 Customobjects Customobjectkey Records
DeleteCustomObjectRecordByExternalIdOrName 3 params → 204
GET
/api/v2/custom_objects/{custom_object_key}/records/{custom_object_record_id}
Zendesk Get Api V2 Customobjects Customobjectkey Records Customobjectrecordid
ShowCustomObjectRecord 2 params → 200
PATCH
/api/v2/custom_objects/{custom_object_key}/records/{custom_object_record_id}
Zendesk Patch Api V2 Customobjects Customobjectkey Records Customobjectrecordid
UpdateCustomObjectRecord 2 params → 200
DELETE
/api/v2/custom_objects/{custom_object_key}/records/{custom_object_record_id}
Zendesk Delete Api V2 Customobjects Customobjectkey Records Customobjectrecordid
DeleteCustomObjectRecord 2 params → 204
GET
/api/v2/custom_objects/{custom_object_key}/records/count
Zendesk Get Api V2 Customobjects Customobjectkey Records Count
CountCustomObjectRecords 1 param → 200
GET
/api/v2/custom_objects/{custom_object_key}/records/search
Zendesk Get Api V2 Customobjects Customobjectkey Records Search
SearchCustomObjectRecords 6 params → 200
POST
/api/v2/custom_objects/{custom_object_key}/records/search
Zendesk Post Api V2 Customobjects Customobjectkey Records Search
FilteredSearchCustomObjectRecords 6 params body → 200
GET
/api/v2/custom_objects/limits/record_limit
Zendesk Get Api V2 Customobjects Limits Recordlimit
CustomObjectRecordsLimit → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CustomObjectRecordsResponse (4 properties), CustomObjectLimitsResponse (2 properties), CustomObjectRecordResponse (1 property). Each schema is shown below with its type and property counts.

CustomObjectLimitsResponse
object
2 properties
CustomObjectRecordResponse
object
1 property
CustomObjectRecordsResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendesk-custom-object-records-api-openapi.yml Raw ↑

Other APIs Zendesk publishes across the network.

Zendesk Help Center Articles API
Zendesk Help Center Sections API
Zendesk Help Center Categories API
Zendesk Help Center Translations API
Zendesk Help Center Article Attachments API
Zendesk Help Center Article Comments API
Zendesk Help Center Article Labels API
Zendesk Help Center Topics API
Zendesk Help Center Posts API
Zendesk Help Center Post Comments API
Zendesk Help Center Votes API
Zendesk Help Center Content Subscriptions API