Get user accounts

get

https://{region}.apigw.jamf.com/api/pro/v1/tenant/{tenantId}/accounts

Get all user accounts with pagination, sorting, and filtering support.

Required Permissions: read:pro:accounts

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

uuid

required

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier

Query Params

page

integer

Defaults to 0

page-size

integer

Defaults to 100

sort

array of strings

Defaults to username:asc

Sorting criteria in the format: property:asc/desc. Default sort is
username:desc. Multiple sort criteria are supported and must be separated with a comma.
Accepts fields: id, lastPasswordChange, failedLoginAttempts, username, realname, email, phone, ldapServerId, distinguishedName, siteId, privilegeLevel, changePasswordOnNextLogin, accountStatus.
If any other field is passed it will be ignored in sorting operation and/or create unpredictable results.

sort

filter

string

Query in the RSQL format to filter user accounts collection. An empty query returns all results for the requested page.
Supported fields: id, lastPasswordChange, failedLoginAttempts, username, realname, email, phone, ldapServerId, distinguishedName, siteId, privilegeLevel, changePasswordOnNextLogin, accountStatus.
Multiple conditions can be combined using logical operators.
This parameter can be used with paging and sorting parameters.
Example: username=="admin" and accountStatus==Enabled and failedLoginAttempts==0

Response

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

200User accounts retrieved successfully