List Site Users
GET /sites/{site_id}/users
Retrieves a list of users for a site.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
site_id |
string | Yes | ID of the site to retrieve users from |
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
slim |
flag | Omitted | Include this parameter to return fewer fields. Omit it for the standard shape. |
slim_reservables |
boolean | false |
Return slimmer reservable objects when included |
limit |
integer | null |
Number of results to return |
offset |
integer | 0 |
Offset row to start at |
email |
string | null |
Filter users by email (matches exact only) |
search |
string | null |
Filter users by name and email (matches substrings) |
usergroup |
integer | null |
Usergroup ID to filter by |
supervisor_id |
string | null |
User ID of the supervisor to filter by |
user_bots_only |
boolean | false |
Only return bots or test users |
Response
Success Response (200 OK)
data contains site users. numitems counts the returned entries by default. Use return_count=true for the total before pagination. When the site is inaccessible, the API can return an empty list.
Error Responses
400 Bad Request: Invalid request or validation error401 Unauthorized: Authentication failed
See the Site Users API overview for related endpoints and shared data structures.