Zendesk

Zendesk Users API

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

Documentation GitHub OpenAPI

Operations 30

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/users/autocomplete Autocomplete users by the start of their name · Zendesk Get Api V2 Users Autocomplete #

Ask an LLM

“Can I get user suggestions as someone types the first letters of a name?”

“Which users have a name beginning with a given prefix, excluding ones with foreign identities?”

Tell an agent

Suggest users whose names start with {name}.

Autocomplete the user name prefix {name} for my ticket form.

GET /api/v2/deleted_users List deleted users · Zendesk Get Api V2 Deleted_users #

Ask an LLM

“Where can I see every user that has been deleted from my Zendesk account?”

“Does the deleted users list include people who were permanently deleted?”

Tell an agent

List all the users that have been deleted, including permanently deleted ones.

Show me the deleted user records in the account.

GET /api/v2/deleted_users/{deleted_user_id} Show a soft-deleted user · Zendesk Get Api V2 Deleted_users Deleted_user_id #

Ask an LLM

“Can I look up the details of one user that was deleted but not yet permanently removed?”

“What does a single soft-deleted user record still contain?”

Tell an agent

Fetch the record of a single deleted user who has not been permanently removed yet.

Pull up one soft-deleted user's details by their deleted user ID.

DELETE /api/v2/deleted_users/{deleted_user_id} Permanently delete a deleted user · Zendesk Delete Api V2 Deleted_users Deleted_user_id #

Ask an LLM

“How do I permanently erase a user's personal data after they have already been deleted?”

“Is permanently deleting a user reversible?”

Tell an agent destructive · confirm first

Permanently erase a user I already soft-deleted, including all their info.

Purge a previously deleted user for good to meet a GDPR erasure request.

GET /api/v2/deleted_users/count Count deleted users · Zendesk Get Api V2 Deleted_users Count #

Ask an LLM

“How many users have been deleted from my account so far?”

“How fresh is the deleted user count when there are more than 100,000?”

Tell an agent

Give me the approximate number of deleted users.

Count the deleted users and tell me when that count was last refreshed.

GET /api/v2/users/search Search users by query or external ID · Zendesk Get Api V2 Users Search #

Ask an LLM

“Can I search the agents and end users in my help desk with a search query?”

“What is the maximum number of users a single user search can return?”

Tell an agent

Search users in the api/v2 user search for {query}.

Find the user whose external ID is {external_id}.

GET /api/v2/users List all users in the account · Zendesk Get Api V2 Users #

Ask an LLM

“What is the recommended way to page through every user in my account?”

“How many users does each page of the api/v2 user list return?”

Tell an agent

List every user in the account using cursor pagination.

Page through all users from the v2 users endpoint, 100 at a time.

POST /api/v2/users Create a user · Zendesk Post Api V2 Users #

Ask an LLM

“How do I add a new single user through the api/v2 users endpoint?”

“Can I create an agent or end user record from my own signup flow?”

Tell an agent

Create a new user record via the v2 users endpoint.

Add one new end user to my Zendesk account.

GET /api/v2/users/{user_id} Show a user · Zendesk Get Api V2 Users User_id #

Ask an LLM

“Can I fetch the full profile of one user from the v2 API by their ID?”

“What details does the v2 show-user call return for an agent?”

Tell an agent

Show the v2 profile for user {user_id}.

Look up user {user_id} through api/v2.

PUT /api/v2/users/{user_id} Update a user · Zendesk Put Api V2 Users User_id #

Ask an LLM

“Can I change an existing user's details through the v2 users endpoint?”

“Which call edits a single user record under api/v2?”

Tell an agent

Update user {user_id} through the v2 users endpoint.

Edit the v2 record of user {user_id}.

DELETE /api/v2/users/{user_id} Delete a user and associated records · Zendesk Delete Api V2 Users User_id #

Ask an LLM

“What happens to a user's associated records when I delete them via api/v2?”

“Can a user deleted through the v2 endpoint be recovered?”

Tell an agent destructive · confirm first

Delete user {user_id} and their associated records via api/v2.

Remove user {user_id} from the account using the v2 delete call.

GET /api/v2/users/{user_id}/compliance_deletion_statuses Show a user's GDPR deletion status · Zendesk Get Api V2 Users User_id Compliance_deletion_statuses #

Ask an LLM

“How can I check whether a user's GDPR deletion has finished in each product area?”

“Can I see the compliance deletion status for just one area such as support/explore?”

Tell an agent

Show the compliance deletion statuses for user {user_id}.

Check the GDPR deletion status of user {user_id} in the {application} area.

PUT /api/v2/users/{user_id}/merge Merge two end users · Zendesk Put Api V2 Users User_id Merge #

Ask an LLM

“Can I merge a duplicate end user account into another end user?”

“Why would merging an end user with more than 10,000 requested tickets be blocked?”

Tell an agent destructive · confirm first

Merge end user {user_id} into the other end user I specify.

Combine duplicate end user {user_id} with their existing account.

GET /api/v2/users/{user_id}/related Show a user's related information · Zendesk Get Api V2 Users User_id Related #

Ask an LLM

“Where can I get the related info summary for a user, such as their ticket counts?”

“Is there a call that returns data related to a user rather than the profile itself?”

Tell an agent

Show the related information for user {user_id}.

Get the related-records summary of user {user_id}.

GET /api/v2/users/count Count users · Zendesk Get Api V2 Users Count #

Ask an LLM

“How many users are in my account in total?”

“When was the approximate user count last refreshed?”

Tell an agent

Give me the approximate total number of users.

Count the users in the account.

POST /api/v2/users/create_many Bulk create up to 100 users · Zendesk Post Api V2 Users Create_many #

Ask an LLM

“Can I import a batch of users in a single request?”

“Why would a bulk user import be rejected when it isn't enabled on my account?”

Tell an agent

Bulk import this array of up to 100 new users.

Create many users at once as a background job.

POST /api/v2/users/create_or_update Create or update a user by email or external ID · Zendesk Post Api V2 Users Create_or_update #

Ask an LLM

“Can I upsert a user so it is created if missing or updated if the email already exists?”

“What role does a new user get from create-or-update if I leave the role out?”

Tell an agent

Upsert a single user matched by email address or external ID.

Create this user, or update them if they already exist.

POST /api/v2/users/create_or_update_many Bulk create or update up to 100 users · Zendesk Post Api V2 Users Create_or_update_many #

Ask an LLM

“Is there a bulk upsert for a list of users?”

“What limit applies when syncing many users so each is created or updated?”

Tell an agent

Sync this array of up to 100 users, creating the new ones and updating the rest.

Bulk upsert many users from my CRM export.

DELETE /api/v2/users/destroy_many Bulk delete up to 100 users · Zendesk Delete Api V2 Users Destroy_many #

Ask an LLM

“Can I delete a whole list of users at once?”

“Does the bulk user delete accept external IDs instead of Zendesk IDs?”

Tell an agent destructive · confirm first

Delete the users with IDs {ids} in bulk.

Bulk delete the users whose external IDs are {external_ids}.

POST /api/v2/users/logout_many Log out many users · Zendesk Post Api V2 Users Logout_many #

Ask an LLM

“Can an admin force several users to sign out at the same time?”

“How many users can be logged out in one request?”

Tell an agent

Sign out the users {ids} from all their sessions.

Force-logout this comma-separated list of user IDs: {ids}.

GET /api/v2/users/me Show the currently signed-in user · Zendesk Get Api V2 Users Me #

Ask an LLM

“Who am I authenticated as when I call the API?”

“Where do I get the authenticity token for requests made by end users?”

Tell an agent

Show the user I'm authenticated as, with the authenticity token.

Tell me which account my current credentials belong to.

POST /api/v2/users/request_create Ask the owner to add agent seats · Zendesk Post Api V2 Users Request_create #

Ask an LLM

“Can an agent nudge the account owner to upgrade so more agents can be created?”

“What does the request-create call send to the account owner?”

Tell an agent

Email the account owner a reminder to update the subscription for more agents.

Request more agent seats from the owner.

GET /api/v2/users/show_many Show many users by ID · Zendesk Get Api V2 Users Show_many #

Ask an LLM

“Can I fetch several specific users in one call?”

“What is the maximum number of IDs I can pass when retrieving multiple users?”

Tell an agent

Retrieve the users with IDs {ids}.

Get the user records for external IDs {external_ids}.

PUT /api/v2/users/update_many Bulk update users · Zendesk Put Api V2 Users Update_many #

Ask an LLM

“Can I apply the same change to a list of users in one request?”

“Does bulk user update let me target users by their external IDs?”

Tell an agent

Apply this update to users {ids}.

Bulk update the users with external IDs {external_ids}.

GET /users List users filtered by role or permission set · Zendesk List Users #

Ask an LLM

“Can I list only the admins, agents or end users in the account?”

“Which users are assigned a particular custom permission set?”

Tell an agent

List users with the {role} role.

Show users in permission set {permission_set}, {per_page} per page.

POST /users Create a user with name and email or phone · Zendesk Create User #

Ask an LLM

“What is the minimum I must provide to create a user, a name plus email or phone?”

“Does a newly created user default to the end-user role?”

Tell an agent

Create the user described by {user}.

Register {user} as a new end user with a name and phone number.

GET /users/{user_id} Get a user's details · Zendesk Show User #

Ask an LLM

“Where can I read the details of a specific person on the /users path?”

“Can I retrieve one customer's record to see their role and organization?”

Tell an agent

Get the details for user {user_id}.

Retrieve customer {user_id}'s role and organization.

PUT /users/{user_id} Change a user's name, email, role or tags · Zendesk Update User #

Ask an LLM

“Can I change a user's role, organization, tags or custom fields?”

“Which properties of a person can I modify, such as their email?”

Tell an agent

Set user {user_id}'s properties to {user}.

Change the role and tags of user {user_id} to what's in {user}.

DELETE /users/{user_id} Soft-delete a user · Zendesk Delete User #

Ask an LLM

“Can a soft-deleted user be recovered within a limited time?”

“Who is allowed to delete agents and admins?”

Tell an agent destructive · confirm first

Soft-delete user {user_id}.

Remove person {user_id} so they can still be restored for a while.

GET /users/search Search users by name, email or external ID · Zendesk Search Users #

Ask an LLM

“Can I look people up by name or email address and page through matches?”

“How can I control how many matching people come back per page?”

Tell an agent

Look up people matching {query}.

Find users by email {query}, page {page}.

Zendesk Users API

Operations 30

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