User AccountsUsers

List Users

Get a list of users for a site

Path parameters

site_idstringRequiredformat: "uuid"

Unique identifier for a Site

Headers

AuthorizationstringRequired

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

Accept-VersionstringOptional

The API version

Query parameters

offsetintegerOptional

Offset used for pagination if the results have more than limit records

limitintegerOptional

Maximum number of records to be returned (max limit: 100)

sortenumOptional

Sort string to use when ordering users

Example(CreatedOn, Email, Status, LastLogin, UpdatedOn).

Can be prefixed with a - to reverse the sort (ex. -CreatedOn)

Response

Request was successful

countintegerOptional

Number of users returned

limitintegerOptionalDefaults to 100

The limit specified in the request

offsetintegerOptionalDefaults to 0

The offset specified for pagination

totalintegerOptional

Total number of users in the collection

userslist of objectsOptional

List of Users for a Site

Errors