API ReferenceUsers

List users

Gets a list of users

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Disable-Hooks"true"Required

Query parameters

emailstringOptional
Email of guest to return
searchstringOptional
String to search for users by name and email
sortFieldenumOptional
Field to sort users by
sortDirectionenumOptional
Direction of sorting
Allowed values:
pageSizeintegerOptional

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

pageNumberintegerOptional
Based on pageSize, which page of users to return

Response

This endpoint returns an object.
datalist of objects
paginationobject or null
pagination info