v1
latestOpenAPI 3.0.02026-07-14198572488.4 KBSite Users
List all the site users for a Site
For a given site, list all site user which have access to it
get/v1/sites/{id}/users
Path parameters
idinteger required
ID of the Site you are interacting with
Example:8880000888
Query parameters
searchstring
Search based on the site user's email/name
Example:siteuser@rocket.net
pageinteger
Page of results to include (default = 1)
per_pageinteger
How many results to include in each page (default = 10)
sort'email' | 'user_id' | 'status'
Sort results by the following property
direction'asc' | 'desc' | 'ASC' | 'DESC'
Direction to sort results in (asc = ascending, desc = descending)
Response
OK
Example response
{
"success": true,
"errors": [],
"messages": [],
"metadata": {
"page": 1,
"page_size": 10,
"total": 150
},
"result": [
{
"id": 5,
"site_id": 8880000888,
"name": "Ms. Site User",
"email": "siteuser@rocket.net",
"created_at": "2024-01-01T02:00:00Z"
}
]
}