List users

GET

Gets a list of users

Headers

X-Disable-Hooks"true"RequiredDefaults to true

Query parameters

emailstringOptional

Email of guest to return

searchstringOptional

String to search for users by name and email

sortFieldenumOptional

Field to sort users by

sortDirection"asc" or "desc"Optional

Direction of sorting

Allowed values: ascdesc

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

paginationobjectOptional

pagination info