v1
latestOpenAPI 3.1.02026-08-065163115.0 KBUsers
List users
This endpoint allows you to retrieve a list of users for a given business.
get/v1/businesses/{client_id}/users
Path parameters
client_idinteger required
Example:123
The ID of the business.
Query parameters
offsetinteger
Example:50
Offset to retrieve items from.
limitinteger
Example:50
Number of items per page.
Response
OK
Example response
{
"count": 100,
"next": "offset=50&limit=50",
"previous": "offset=0&limit=50",
"results": [
{
"id": 123,
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "john.doe@example.com",
"role": "Team Member",
"role_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"created": "2024-01-01T00:00:00Z",
"updated": "2024-01-01T00:00:00Z",
"payment_types": [
"cards"
],
"out_of_office_mode": true,
"out_of_office_start_date": "2026-06-01",
"out_of_office_end_date": "2026-06-15",
"delegate_approver": 789,
"expense_delegate": [
456,
789
]
}
]
}