API Reference

Get users with pagination

get
https://project-api.zapehr.com/v1/user/v2/list

Get Users in the Project with pagination, sort, sort order and filtering. Users are the people who log into the Applications you configure for securing the apps you build on top of Oystehr.

Access Policy Action: Project:ListAllUsers
Access Policy Resource: Project:Settings

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

Filter users by name.

uuid

Filter user by id

string

Filter users by email address.

string

Filter users by profile. Expected format: 'FhirResource/UUID'.

uuid

Filter users by role UUID.

string

Cursor for pagination to fetch next set of users.

integer
1 to 100
Defaults to 25

Maximum number of users to return per query.

string
enum
Defaults to createdAt

Field to sort the users by.

Allowed:
string
enum
Defaults to asc

Order of sorting (ASC or DESC).

Allowed:
Responses

Updated 12 months ago

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

Updated 12 months ago