v1
latestOpenAPI 3.0.02026-07-24212113249.1 KBList accounts
Query parameters
The number of documents that will be returned per page
Page to search. Page numbering starts with 0.
The sort-by field name and order. Format: <field_name>.<asc|desc> (asc for ascending and desc for descending order). If no order is specified, descending order is used.
Tenant ID
Filter by email address.
Filter by user name.
Return only accounts where the user name contains this string.
Filter by owner's first name.
Return only accounts where the owner's first name contains this string.
Filter by owner's last name.
Return only accounts where the owner's last name contains this string.
Return only admin accounts.
If True, return only active accounts.
Return only accounts temporarily blocked until this date.
Return only permanently blocked accounts.
If True, return only accounts that are pending activation.
Return only accounts that have a GDPR requirement.
Filter by this term.
Headers
The URL of the end-user web application
Response
Successful resopnse
Example response
{
"page": 1,
"pageSize": 20,
"total": 1,
"pageCount": 1,
"pageNumberIsGood": true,
"isFirstPage": true,
"isLastPage": true,
"rows": [
{
"id": "646f8e4619b10e18eb768ea5",
"display_name": "John Smith",
"username": "John Smith",
"first_name": "John",
"last_name": "Smith",
"email": "johnsmith@server.com",
"status": {
"active": true
},
"organization": "864soq9a3efc39a89a96d4sz",
"is_admin": true
}
]
}