Zendesk Custom Object Fields 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 Fields. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.
This API exposes
7 operations
across 4 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.
7 operations4 paths3 schemas1 DELETE3 GET1 PATCH1 POST1 PUT
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 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Custom Object Fields 7
GET
/api/v2/custom_objects/{custom_object_key}/fields
Zendesk Get Api V2 Customobjects Customobjectkey Fields
ListCustomObjectFields2 params→ 200
POST
/api/v2/custom_objects/{custom_object_key}/fields
Zendesk Post Api V2 Customobjects Customobjectkey Fields
Zendesk Get Api V2 Customobjects Customobjectkey Limits Fieldlimit
CustomObjectFieldsLimit1 param→ 200
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CustomObjectLimitsResponse (2 properties), CustomObjectFieldResponse (1 property), CustomObjectFieldsResponse (1 property). Each schema is shown below with its type and property counts.
CustomObjectFieldsResponse
object
1 property
CustomObjectLimitsResponse
object
2 properties
CustomObjectFieldResponse
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
