Zendesk

Zendesk Object Layouts API

The Zendesk Object Layouts API lets you programmatically control how record pages look and behave in Agent Workspace. It provides CRUD endpoints to define which fields and components appear for an object (such as tickets, users, organizations, and Sunshine custom objects), how theyre grouped and ordered into sections or panels, and any conditional visibility rules.

Documentation GitHub OpenAPI

Documentation

📖

Documentation

https://developer.zendesk.com/api-reference/ticketing/introduction/

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/openapi/object-layouts-openapi-original.yml

OpenAPI Specification

openapi: 3.1.0
info:
  version: "1.0"
  title: Zendesk Object Layouts
  description: Needs a description.
paths:
  /api/v2/object_layouts/{object_type}/essentials_card:
    parameters:
      - $ref: '#/components/parameters/EssentialsCardKey'
    get:
      operationId: ShowEssentialsCard
      tags:
        - Essentials Card
      summary: Zendesk Get  Api V2 Object_layouts Object_type Essentials_card
      description: |
        Gets the essentials card for an object type.
        #### Allowed For
        * Admins and agents
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EssentialsCardResponse'
              examples:
                default:
                  $ref: '#/components/examples/EssentialsCardExample'
    put:
      operationId: UpdateEssentialsCard
      tags:
        - Essentials Card
      summary: Zendesk Put  Api V2 Object_layouts Object_type Essentials_card
      description: |
        Updates the essentials card for an object type.
        #### Allowed For
        * Admins
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EssentialsCardResponse'
              examples:
                default:
                  $ref: '#/components/examples/EssentialsCardExample'
    delete:
      operationId: DeleteEssentialsCard
      tags:
        - Essentials Card
      summary: Zendesk Delete  Api V2 Object_layouts Object_type Essentials_card
      description: |
        Delete the essentials card for an object type.
        #### Allowed For
        * Admins and agents
      responses:
        '204':
          description: Success response
  /api/v2/object_layouts/essentials_cards:
    get:
      operationId: ShowEssentialsCards
      tags:
        - Essentials Card
      summary: Zendesk Get  Api V2 Object_layouts Essentials_cards
      description: |
        Gets the list of essentials cards.
        #### Allowed For
        * Admins
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EssentialsCardsResponse'
              examples:
                default:
                  $ref: '#/components/examples/EssentialsCardsExample'
components:
  schemas:
    EssentialsCardResponse:
      type: object
      properties:
        object_layout:
          $ref: '#/components/schemas/EssentialsCardObject'
    EssentialsCardsResponse:
      type: object
      properties:
        object_layouts:
          type: array
          items:
            $ref: '#/components/schemas/EssentialsCardObject'
tags:
  - name: Essentials Card