v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB
users

List users

Gets a list of users

get/users

Query parameters

emailstring

Email of guest to return

searchstring

String to search for users by name and email

sortField'email' | 'name' | 'id' | 'idp' | 'idp_ref' | 'created_at' | 'updated_at' | 'last_seen_at' | 'dashboard'

Field to sort users by

sortDirection'asc' | 'desc'

Sort direction - asc (ascending) or desc (descending)

Direction of sorting

pageSizeinteger

Number of users to return in a page (default 20)

pageNumberinteger

Based on pageSize, which page of users to return

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Response

Response with status 200