Zendesk

Zendesk Custom Object Fields API

The Custom Object Fields API from Zendesk — 4 operation(s) for custom object fields.

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v2/custom_objects/{custom_object_key}/fields List fields of a custom object · Zendesk Get Api V2 Custom_objects Custom_object_key Fields #
Ask an LLM
“What fields are defined on one of my custom objects?”
“Are deleted fields left out when listing custom object fields?”
Tell an agent
List the fields on this custom object.
Show all active fields of the Vehicle custom object.
POST /api/v2/custom_objects/{custom_object_key}/fields Add a field to a custom object · Zendesk Post Api V2 Custom_objects Custom_object_key Fields #
Ask an LLM
“Can I add a lookup or dropdown field to a custom object?”
“Which field types are allowed on custom objects?”
Tell an agent
Add a text field called VIN to the Vehicle custom object.
Create a date field on this custom object.
GET /api/v2/custom_objects/{custom_object_key}/fields/{custom_object_field_key_or_id} Get a custom object field · Zendesk Get Api V2 Custom_objects Custom_object_key Fields… #
Ask an LLM
“Can I fetch a custom object field by its key or id?”
“Where are one custom object field's settings?”
Tell an agent
Show this field of the custom object.
Get the VIN field definition on the Vehicle object.
PATCH /api/v2/custom_objects/{custom_object_key}/fields/{custom_object_field_key_or_id} Update a custom object field · Zendesk Patch Api V2 Custom_objects Custom_object_key Fields… #
Ask an LLM
“Can I change a custom object field's title after creating it?”
“Which properties of a custom object field cannot be updated?”
Tell an agent
Update the title of this custom object field.
Edit the options of the dropdown field on the Vehicle object.
DELETE /api/v2/custom_objects/{custom_object_key}/fields/{custom_object_field_key_or_id} Delete a custom object field · Zendesk Delete Api V2 Custom_objects Custom_object_key Fields… #
Ask an LLM
“Can I remove a field from a custom object?”
“Is it possible to delete a standard custom object field?”
Tell an agent destructive · confirm first
Delete this field from the custom object.
Remove the unused VIN field from Vehicle.
PUT /api/v2/custom_objects/{custom_object_key}/fields/reorder Reorder a custom object's fields · Zendesk Put Api V2 Custom_objects Custom_object_key Fields Reorder #
Ask an LLM
“Can I set the display order of a custom object's fields?”
“Who is allowed to reorder custom object fields?”
Tell an agent
Reorder the fields on this custom object.
Put the VIN field first on the Vehicle object.
GET /api/v2/custom_objects/{custom_object_key}/limits/field_limit Check a custom object's field limit · Zendesk Get Api V2 Custom_objects Custom_object_key Limits Field_limit #
Ask an LLM
“How many more fields can I add to a custom object?”
“What is the field limit for a custom object and how many are used?”
Tell an agent
Show the field count and limit for this custom object.
Check how close the Vehicle object is to its field limit.

Documentation

📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/introduction/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/targets/targets/
📖
Documentation
https://developer.zendesk.com/api-reference/sales-crm/resources/account/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/activity_stream/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/channel_framework/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/audit_logs/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/bookmarks/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/brand_agents/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/
📖
Documentation
https://developer.zendesk.com/api-reference/live-chat/chat-api/chats/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/
📖
Documentation
https://developer.zendesk.com/api-reference/custom-data/introduction/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/custom_ticket_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/users/users/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/deletion_schedules/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/email_notifications/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/group_sla_policies/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/groups/groups/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_import/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_subscriptions/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/push_notification_devices/
📖
Documentation
https://developer.zendesk.com/api-reference/agent-availability/omnichannel_routing_queues/omnichannel_routing_queues/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/support_addresses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/lookup_relationships/lookup_relationships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-requests/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/resource_collections/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/skill_based_routing/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_reasons/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_skips/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_audits/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_form_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_metrics/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/views/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/workspaces/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/openapi/zendesk-custom-object-fields-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/json-schema/zendesk-ticket-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/json-schema/zendesk-user-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/json-ld/zendesk-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zendesk:zendesk-custom-object-fields-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zendesk-custom-object-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '1.0'
  title: Zendesk Custom Objects Custom Object Fields API
  description: Needs a description.
tags:
- name: Custom Object Fields
paths:
  /api/v2/custom_objects/{custom_object_key}/fields:
    get:
      operationId: ListCustomObjectFields
      tags:
      - Custom Object Fields
      summary: Zendesk Get Api V2 Custom_objects Custom_object_key Fields
      description: 'Lists all undeleted custom fields for the specified object.


        #### Allowed For

        * Agents


        #### Pagination

        * Cursor pagination (recommended)

        * Offset pagination


        See Pagination.'
      parameters:
      - $ref: '#/components/parameters/CustomObjectKey'
      - $ref: '#/components/parameters/IncludeStandardFields'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectFieldsResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomObjectFieldsResponseExample'
    post:
      operationId: CreateCustomObjectField
      tags:
      - Custom Object Fields
      summary: Zendesk Post Api V2 Custom_objects Custom_object_key Fields
      description: 'Creates any of the following custom field types:


        * text (default when no "type" is specified)

        * textarea

        * checkbox

        * date

        * integer

        * decimal

        * regexp

        * dropdown

        * lookup

        * multiselect


        See About custom field types in Zendesk help.


        #### Allowed For


        * Admins'
      parameters:
      - $ref: '#/components/parameters/CustomObjectKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomObjectFieldsCreateRequest'
            examples:
              default:
                $ref: '#/components/examples/CustomObjectFieldsCreateRequestExample'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectFieldResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomObjectFieldCreateResponseExample'
  /api/v2/custom_objects/{custom_object_key}/fields/{custom_object_field_key_or_id}:
    get:
      operationId: ShowCustomObjectField
      tags:
      - Custom Object Fields
      summary: Zendesk Get Api V2 Custom_objects Custom_object_key Fields…
      description: 'Returns a custom field for a specific object using a provided key or id of the field.

        #### Allowed For

        * Agents'
      parameters:
      - $ref: '#/components/parameters/CustomObjectKey'
      - $ref: '#/components/parameters/CustomObjectFieldKeyOrId'
      responses:
        '200':
          description: Custom Object Field
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectFieldResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomObjectFieldCreateResponseExample'
    patch:
      operationId: UpdateCustomObjectField
      tags:
      - Custom Object Fields
      summary: Zendesk Patch Api V2 Custom_objects Custom_object_key Fields…
      description: 'Updates individual custom object fields. The updating rules are as follows:

        * Takes a `custom_object_field` object that specifies the properties to update

        * The `key` property cannot be updated

        * If updating a standard field, only the `title`, `description`, and `properties` attributes can be updated.

        * The `properties` parameter is comprised of four parts and can''t be changed if any records exist for the object.

        * `autoincrement_enabled`: A Boolean that enables and disables autonumbering. Must be false if is_unique is true.

        * `autoincrement_prefix`: A string value that is used as a prefix to the autogenerated numbers. It can''t exceed 30 characters.

        * `autoincrement_padding`: An integer specifying the starting number of digits in the autogenerated numbers. This value may be between 0-9. However, if you create records in excess of of these digits, additional digits are added as necessary.

        * `autoincrement_next_sequence`: An integer that will be used as the next number in the autonumbering sequence. It can''t be negative or less than the current autonumbering value.

        * `is_unique`: A Boolean that enforces uniqueness for manually entered record names. When true, custom object record names must be unique. Must be false if autoincrement_enabled is true.

        #### Allowed For

        * Admins'
      parameters:
      - $ref: '#/components/parameters/CustomObjectKey'
      - $ref: '#/components/parameters/CustomObjectFieldKeyOrId'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectFieldResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomObjectFieldCreateResponseExample'
    delete:
      operationId: DeleteCustomObjectField
      tags:
      - Custom Object Fields
      summary: Zendesk Delete Api V2 Custom_objects Custom_object_key Fields…
      description: 'Deletes a field with the specified key. Note: You can''t delete standard fields.

        #### Allowed For

        * Admins'
      parameters:
      - $ref: '#/components/parameters/CustomObjectKey'
      - $ref: '#/components/parameters/CustomObjectFieldKeyOrId'
      responses:
        '204':
          description: No content response
  /api/v2/custom_objects/{custom_object_key}/fields/reorder:
    put:
      operationId: ReorderCustomObjectFields
      tags:
      - Custom Object Fields
      summary: Zendesk Put Api V2 Custom_objects Custom_object_key Fields Reorder
      description: 'Sets a preferred order of custom fields for a specific object by providing field ids in the desired order.

        #### Allowed For


        * Admins'
      parameters:
      - $ref: '#/components/parameters/CustomObjectKey'
      responses:
        '200':
          description: Reordered
          content:
            application/json:
              schema:
                type: string
                description: Empty response
                example: ''
              example: ''
  /api/v2/custom_objects/{custom_object_key}/limits/field_limit:
    get:
      operationId: CustomObjectFieldsLimit
      tags:
      - Custom Object Fields
      summary: Zendesk Get Api V2 Custom_objects Custom_object_key Limits Field_limit
      description: 'List the current count and the limit for a custom object''s fields

        #### Allowed For

        * Agents'
      parameters:
      - $ref: '#/components/parameters/CustomObjectKey'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectLimitsResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomObjectFieldsLimitResponseExample'
components:
  schemas:
    CustomObjectFieldsResponse:
      type: object
      properties:
        custom_object_fields:
          type: array
          items:
            $ref: '#/components/schemas/CustomObjectField'
    CustomObjectLimitsResponse:
      type: object
      properties:
        count:
          type: integer
          description: The current numnber of the requested resource
          readOnly: true
        limit:
          type: integer
          description: The maximum allowed number for the requested resource
          readOnly: true
    CustomObjectFieldResponse:
      type: object
      properties:
        custom_object_field:
          $ref: '#/components/schemas/CustomObjectField'