CommunityWebsiteDocumentationExchangeSupportDeveloper
HomeGuidesAPI Reference
CommunityWebsiteDocumentationExchangeSupportDeveloper
API Reference

List All Users

get
https://{serverURL}/api/users

This endpoint retrieves all users in the current user's tenant account. Master tenant users with permission to manage subtenants can use global=true to find users across all tenants.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
Defaults to 25

Maximum number of records to return

int64
Defaults to 0

Offset records, the number of records to skip, for paginating requests

string

Sort order, the name of the property to sort by. The default sort order is username ascending

string
enum
Defaults to asc

Sort direction, use 'desc' to reverse sort

Allowed:
string

Search phrase for partial matches on username or email

string

Username

string

E-Mail Address

int64

Filter by Role ID (supports multiple values)

date-time

Date filter, restricts query to only load resources updated more recently than the date specified (ISO 8601)

int64

Filter by Tenant ID. This is only available to master tenant users with permission to manage tenants and users.

boolean
Defaults to false

Global (All Tenants), load users from all tenants. The default is to only see your own tenant. This is only available to master tenant users with permission to manage tenants and users.

Responses

Updated over 2 years ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago