API Reference

Retrieve users with pagination and filtering

get
https://{region}.apigw.jamf.com/api/pro/v1/tenant//users

Retrieves a paginated list of users with optional filtering and sorting.

Required Permissions: read:pro:user

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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
int32
≥ 0
Defaults to 0

Page to display. Uses zero-based indexing.

int32
1 to 1000
Defaults to 100

Number of results per page. Maximum of 1000.

sort
array of strings
Defaults to id:asc

Sorting criteria in the format: property(:asc|desc). Default sort order is ascending.
Multiple sort criteria are supported.

Examples:

  • sort=username
  • sort=username:asc
  • sort=username:asc,realname:desc
sort
string

RSQL filter to limit results. Supports all user fields.

Examples:

  • filter=username=="john*"
  • filter=realname=="John Smith"
  • filter=email=="*@jamf.com"
  • filter=position=="Manager";id!="1"
  • filter=id=in=(123,456,789)
boolean
Defaults to false

Optional. Return platform identifiers instead of internal identifiers when set to true.

Responses

400

Invalid request parameters

500

Internal server error

Updated 2 months ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 2 months ago

Did this page help you?