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 Essentials Card API

The Essentials Card API from Zendesk — 2 operation(s) for essentials card.

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

This API exposes 4 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against the base URL https://{subdomain}.zendesk.com.

4 operations 2 paths 2 schemas 1 DELETE2 GET1 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 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Essentials Card 4
GET
/api/v2/object_layouts/{object_type}/essentials_card
Zendesk Get Api V2 Objectlayouts Objecttype Essentialscard
ShowEssentialsCard 1 param → 200
PUT
/api/v2/object_layouts/{object_type}/essentials_card
Zendesk Put Api V2 Objectlayouts Objecttype Essentialscard
UpdateEssentialsCard 1 param → 200
DELETE
/api/v2/object_layouts/{object_type}/essentials_card
Zendesk Delete Api V2 Objectlayouts Objecttype Essentialscard
DeleteEssentialsCard 1 param → 204
GET
/api/v2/object_layouts/essentials_cards
Zendesk Get Api V2 Objectlayouts Essentialscards
ShowEssentialsCards → 200

Schemas 2

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

EssentialsCardResponse
object
1 property
EssentialsCardsResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendesk-essentials-card-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