API Reference

Retrieve users with pagination and filtering

get
https://{region}.api.jamfcloud.com/pro/v1/users

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

Required Permissions: users:read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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.

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

The tenant UUID identifier. Send it to address tenant scope. This API is also published at environment scope — send that scope's header instead. Send exactly one scope header per request.

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

The environment UUID identifier. Send it to address environment scope. This API is also published at tenant scope — send that scope's header instead. Send exactly one scope header per request.

Responses

400

Invalid request parameters

500

Internal server error

Updated 15 days ago

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

Updated 15 days ago

Did this page help you?