provider Users GET /users
@utdk/zendesk /users
List users
Returns a list of users in the account. Includes end-users (customers), agents, and administrators. Use filters to narrow results by role or organization.
role query
Filter by user role
enum: end-user, agent, admin
page query
integer
per_page query
integer

Try it

Authentication
Configure credentials for Zendesk Support API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

listusers
GET/users
Returns a list of users in the account. Includes end-users (customers), agents, and administrators. Use filters to narrow results by role or organization.

Filter by user role

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import zendesk from '@utdk/zendesk';

await zendesk.listusers()