UsersUsers

List Users

Get a list of users for a site

Required scope | users:read

Authentication

AuthorizationBearer

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

Path parameters

site_idstringRequiredformat: "objectid"
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
countdouble or null
Number of users returned
limitdouble or nullDefaults to 10
The limit specified in the request
offsetdouble or nullDefaults to 0
The offset specified for pagination
totaldouble or null
Total number of users in the collection
userslist of objects or null
List of Users for a Site

Errors