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 Objects API

The Custom Objects API from Zendesk — 3 operation(s) for custom objects.

Zendesk Custom Objects 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 Objects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 6 operations across 3 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.

6 operations 3 paths 3 schemas 1 DELETE3 GET1 PATCH1 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 6

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

Custom Objects 6
GET
/api/v2/custom_objects
Zendesk Get Api V2 Customobjects
ListCustomObjects → 200
POST
/api/v2/custom_objects
Zendesk Post Api V2 Customobjects
CreateCustomObject body → 201
GET
/api/v2/custom_objects/{custom_object_key}
Zendesk Get Api V2 Customobjects Customobjectkey
ShowCustomObject 1 param → 200
PATCH
/api/v2/custom_objects/{custom_object_key}
Zendesk Patch Api V2 Customobjects Customobjectkey
UpdateCustomObject 1 param → 200
DELETE
/api/v2/custom_objects/{custom_object_key}
Zendesk Delete Api V2 Customobjects Customobjectkey
DeleteCustomObject 1 param → 204
GET
/api/v2/custom_objects/limits/object_limit
Zendesk Get Api V2 Customobjects Limits Objectlimit
CustomObjectsLimit → 200

Schemas 3

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

CustomObjectResponse
object
1 property
CustomObjectLimitsResponse
object
2 properties
CustomObjectsResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendesk-custom-objects-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