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

The Users API from Zendesk — 23 operation(s) for users.

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

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

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

30 operations 23 paths 13 schemas 4 DELETE15 GET7 POST4 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 30

Across 23 paths, the API surfaces 30 operations — 4 DELETE, 15 GET, 7 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 30
GET
/api/v2/users/autocomplete
Zendesk Get Api V2 Users Autocomplete
AutocompleteUsers 3 params → 200
GET
/api/v2/deleted_users
Zendesk Get Api V2 Deletedusers
ListDeletedUsers → 200
GET
/api/v2/deleted_users/{deleted_user_id}
Zendesk Get Api V2 Deletedusers Deleteduserid
ShowDeletedUser 1 param → 200
DELETE
/api/v2/deleted_users/{deleted_user_id}
Zendesk Delete Api V2 Deletedusers Deleteduserid
PermanentlyDeleteUser 1 param → 200
GET
/api/v2/deleted_users/count
Zendesk Get Api V2 Deletedusers Count
CountDeletedUsers → 200
GET
/api/v2/users/search
Zendesk Get Api V2 Users Search
SearchUsers 2 params → 200
GET
/api/v2/users
Zendesk Get Api V2 Users
ListUsers 4 params → 200
POST
/api/v2/users
Zendesk Post Api V2 Users
CreateUser body → 201
GET
/api/v2/users/{user_id}
Zendesk Get Api V2 Users Userid
ShowUser 1 param → 200
PUT
/api/v2/users/{user_id}
Zendesk Put Api V2 Users Userid
UpdateUser 1 param body → 200
DELETE
/api/v2/users/{user_id}
Zendesk Delete Api V2 Users Userid
DeleteUser 1 param → 200
GET
/api/v2/users/{user_id}/compliance_deletion_statuses
Zendesk Get Api V2 Users Userid Compliancedeletionstatuses
ShowUserComplianceDeletionStatuses 2 params → 200
PUT
/api/v2/users/{user_id}/merge
Zendesk Put Api V2 Users Userid Merge
MergeEndUsers 1 param body → 200
GET
/api/v2/users/{user_id}/related
Zendesk Get Api V2 Users Userid Related
ShowUserRelated 1 param → 200
GET
/api/v2/users/count
Zendesk Get Api V2 Users Count
CountUsers 3 params → 200
POST
/api/v2/users/create_many
Zendesk Post Api V2 Users Createmany
CreateManyUsers body → 200
POST
/api/v2/users/create_or_update
Zendesk Post Api V2 Users Createorupdate
CreateOrUpdateUser body → 200201
POST
/api/v2/users/create_or_update_many
Zendesk Post Api V2 Users Createorupdatemany
CreateOrUpdateManyUsers body → 200
DELETE
/api/v2/users/destroy_many
Zendesk Delete Api V2 Users Destroymany
DestroyManyUsers 2 params → 200
POST
/api/v2/users/logout_many
Zendesk Post Api V2 Users Logoutmany
LogoutManyUsers 1 param → 202
GET
/api/v2/users/me
Zendesk Get Api V2 Users Me
ShowCurrentUser → 200
POST
/api/v2/users/request_create
Zendesk Post Api V2 Users Requestcreate
RequestUserCreate body → 200
GET
/api/v2/users/show_many
Zendesk Get Api V2 Users Showmany
ShowManyUsers 2 params → 200
PUT
/api/v2/users/update_many
Zendesk Put Api V2 Users Updatemany
UpdateManyUsers 2 params body → 200
GET
/users
Zendesk List Users
listUsers 4 params → 200401429
POST
/users
Zendesk Create User
createUser body → 201401422429
GET
/users/{user_id}
Zendesk Show User
getUser 1 param → 200401404429
PUT
/users/{user_id}
Zendesk Update User
updateUser 1 param body → 200401404422429
DELETE
/users/{user_id}
Zendesk Delete User
deleteUser 1 param → 200401404429
GET
/users/search
Zendesk Search Users
searchUsers 3 params → 200401429

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are User (36 properties), UserCreate (16 properties), UserUpdate (16 properties), Error (3 properties). Each schema is shown below with its type and property counts.

DeletedUsersResponse
object
1 property
UserResponse
object
1 property
CountResponse
object
1 property
CurrentUserResponse
object
1 property
JobStatusResponse
object
1 property
ComplianceDeletionStatusesResponse
object
1 property
UserCreate
object
Payload for creating a new user.
16 properties 1 required
UsersResponse
object
1 property
DeletedUserResponse
object
1 property
UserUpdate
object
Payload for updating an existing user.
16 properties
User
object
A Zendesk user representing an end user, agent, or admin in the account.
36 properties
UserRelatedResponse
object
1 property
Error
object
An error response from the Zendesk API.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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