List Users

GET

Get a list of users for a site

Required scope | users:read

Path parameters

site_idstringRequired

Unique identifier for a Site

Query parameters

offsetdoubleOptional

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

limitdoubleOptional

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

countdoubleOptional

Number of users returned

limitdoubleOptionalDefaults to 10

The limit specified in the request

offsetdoubleOptionalDefaults to 0

The offset specified for pagination

totaldoubleOptional

Total number of users in the collection

userslist of objectsOptional

List of Users for a Site

Errors