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 Views API

The Views API from Zendesk — 16 operation(s) for views.

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

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

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

19 operations 16 paths 7 schemas 2 DELETE12 GET3 POST2 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 19

Across 16 paths, the API surfaces 19 operations — 2 DELETE, 12 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Views 19
GET
/api/v2/views/search
Zendesk Get Api V2 Views Search
SearchViews 7 params → 200
GET
/api/v2/views/{view_id}/tickets
Zendesk Get Api V2 Views Viewid Tickets
ListTicketsFromView 3 params → 200
GET
/api/v2/views
Zendesk Get Api V2 Views
ListViews 6 params → 200
POST
/api/v2/views
Zendesk Post Api V2 Views
CreateView → 200
GET
/api/v2/views/{view_id}
Zendesk Get Api V2 Views Viewid
ShowView 1 param → 200
PUT
/api/v2/views/{view_id}
Zendesk Put Api V2 Views Viewid
UpdateView 1 param → 200
DELETE
/api/v2/views/{view_id}
Zendesk Delete Api V2 Views Viewid
DeleteView 1 param → 204
GET
/api/v2/views/{view_id}/count
Zendesk Get Api V2 Views Viewid Count
GetViewCount 1 param → 200
GET
/api/v2/views/{view_id}/execute
Zendesk Get Api V2 Views Viewid Execute
ExecuteView 3 params → 200
GET
/api/v2/views/{view_id}/export
Zendesk Get Api V2 Views Viewid Export
ExportView 1 param → 200
GET
/api/v2/views/active
Zendesk Get Api V2 Views Active
ListActiveViews 4 params → 200
GET
/api/v2/views/compact
Zendesk Get Api V2 Views Compact
ListCompactViews → 200
GET
/api/v2/views/count
Zendesk Get Api V2 Views Count
CountViews → 200
GET
/api/v2/views/count_many
Zendesk Get Api V2 Views Countmany
GetViewCounts 1 param → 200
DELETE
/api/v2/views/destroy_many
Zendesk Delete Api V2 Views Destroymany
BulkDeleteViews 1 param → 204
POST
/api/v2/views/preview
Zendesk Post Api V2 Views Preview
PreviewViews → 200
POST
/api/v2/views/preview/count
Zendesk Post Api V2 Views Preview Count
PreviewCount → 200
GET
/api/v2/views/show_many
Zendesk Get Api V2 Views Showmany
ListViewsById 2 params → 200
PUT
/api/v2/views/update_many
Zendesk Put Api V2 Views Updatemany
UpdateManyViews → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ViewResponse (4 properties), ViewsResponse (4 properties), ViewExportResponse (1 property), ViewsCountResponse (1 property). Each schema is shown below with its type and property counts.

ViewCountsResponse
object
1 property
ViewsResponse
object
4 properties
ViewResponse
object
4 properties
TicketsResponse
object
1 property
ViewCountResponse
object
1 property
ViewsCountResponse
object
1 property
ViewExportResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendesk-views-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