Zendesk

Zendesk Custom Objects API

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

Documentation GitHub OpenAPI

Operations 6

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 List custom objects · Zendesk Get Api V2 Custom_objects #

Ask an LLM

“Which custom objects have been defined in my account?”

“Can I see all custom object definitions that are not deleted?”

Tell an agent

List all the custom objects in the account.

Show my custom object definitions.

POST /api/v2/custom_objects Create a custom object · Zendesk Post Api V2 Custom_objects #

Ask an LLM

“How do I define a new custom object type such as Assets or Contracts?”

“Who is allowed to create custom objects?”

Tell an agent

Create a new custom object called Assets.

Define a custom object type to store contract data.

GET /api/v2/custom_objects/{custom_object_key} Show a custom object · Zendesk Get Api V2 Custom_objects Custom_object_key #

Ask an LLM

“Can I view the definition of a custom object by its key?”

“What properties are stored on one custom object?”

Tell an agent

Show the custom object with that key.

Fetch the definition of one custom object.

PATCH /api/v2/custom_objects/{custom_object_key} Update a custom object · Zendesk Patch Api V2 Custom_objects Custom_object_key #

Ask an LLM

“Can I rename or change the description of a custom object?”

“Is the key of a custom object editable after creation?”

Tell an agent

Update the title and description of that custom object.

Change the properties of one existing custom object definition.

DELETE /api/v2/custom_objects/{custom_object_key} Delete a custom object · Zendesk Delete Api V2 Custom_objects Custom_object_key #

Ask an LLM

“Can I permanently delete a custom object I no longer need?”

“Is deleting a custom object reversible?”

Tell an agent destructive · confirm first

Permanently delete the custom object with that key.

Remove the unused custom object definition.

GET /api/v2/custom_objects/limits/object_limit Check the custom object limit · Zendesk Get Api V2 Custom_objects Limits Object_limit #

Ask an LLM

“How many custom objects can my account create in total?”

“How close am I to the maximum number of custom objects?”

Tell an agent

Show the current custom object count against the account limit.

Check how many more custom object types I can define.

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

openapi: 3.2.0
info:
  version: '1.0'
  title: Zendesk Custom Objects API
  description: Needs a description.
tags:
- name: Custom Objects
paths:
  /api/v2/custom_objects:
    get:
      operationId: ListCustomObjects
      tags:
      - Custom Objects
      summary: Zendesk Get Api V2 Custom_objects
      description: 'Lists all undeleted custom objects for the account

        #### Allowed For

        * Agents'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectsResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomObjectsResponseExample'
    post:
      operationId: CreateCustomObject
      tags:
      - Custom Objects
      summary: Zendesk Post Api V2 Custom_objects
      description: 'Creates an object describing all the properties required to create a custom object record

        #### Allowed For

        * Admins'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomObjectsCreateRequest'
            examples:
              default:
                $ref: '#/components/examples/CustomObjectsCreateRequestExample'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomObjectsCreateResponseExample'
  /api/v2/custom_objects/{custom_object_key}:
    get:
      operationId: ShowCustomObject
      tags:
      - Custom Objects
      summary: Zendesk Get Api V2 Custom_objects Custom_object_key
      description: 'Returns an object with the specified key

        #### Allowed For

        * Agents'
      parameters:
      - $ref: '#/components/parameters/CustomObjectKey'
      responses:
        '200':
          description: Custom Object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomObjectsCreateResponseExample'
    patch:
      operationId: UpdateCustomObject
      tags:
      - Custom Objects
      summary: Zendesk Patch Api V2 Custom_objects Custom_object_key
      description: 'Updates an individual custom object. The updating rules are as follows:

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

        * The `key` property cannot be updated

        #### Allowed For

        * Admins'
      parameters:
      - $ref: '#/components/parameters/CustomObjectKey'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomObjectsCreateResponseExample'
    delete:
      operationId: DeleteCustomObject
      tags:
      - Custom Objects
      summary: Zendesk Delete Api V2 Custom_objects Custom_object_key
      description: 'Permanently deletes the custom object with the specified key

        #### Allowed For

        * Admins'
      parameters:
      - $ref: '#/components/parameters/CustomObjectKey'
      responses:
        '204':
          description: No content response
  /api/v2/custom_objects/limits/object_limit:
    get:
      operationId: CustomObjectsLimit
      tags:
      - Custom Objects
      summary: Zendesk Get Api V2 Custom_objects Limits Object_limit
      description: 'List the current count and the limit for custom objects

        #### Allowed For

        * Admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectLimitsResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomObjectsLimitResponseExample'
components:
  schemas:
    CustomObjectResponse:
      type: object
      properties:
        custom_object:
          $ref: '#/components/schemas/CustomObject'
    CustomObjectsResponse:
      type: object
      properties:
        custom_objects:
          type: array
          items:
            $ref: '#/components/schemas/CustomObject'
    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

Zendesk Custom Objects API

Operations 6

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification