GET Users
Use this endpoint to retrieve users.
User level: Advanced
Endpoint
GET /v1/{organizationId}/users| Property | Value |
|---|---|
| Method | GET |
| Scope ID | Organization UUID |
| Authentication | Authorization: Bearer <access_token> |
Query parameters
| Parameter | Type | Default | Max | Description |
|---|---|---|---|---|
limit | integer | 50 | 1000 | Number of records per page. |
offset | integer | 0 | - | Pagination offset. |
sort | string | - | Sort expression in the format field:asc or field:desc. | |
filter | string | - | Filter expression in the format field:operator:value. Repeat filter to combine multiple filters. |
Filtering and sorting
Syntax
sort=field:asc
sort=field:desc
filter=field:operator:valueYou can repeat filter in the same request.
Supported operators
| Operator | Meaning |
|---|---|
eq | Exact match |
ne | Not equal |
in | Value is part of a list |
gt | Greater than |
gte | Greater than or equal |
lt | Less than |
lte | Less than or equal |
like | Case-sensitive text match |
ilike | Case-insensitive text match |
isnull | Null check |
Resource rules
- Filtering and sorting are whitelisted per resource.
organization_idandbranch_idare reserved for server-side scoping and cannot be filtered by clients.- Tenant scope remains server-controlled.
- Use an organization UUID in
{scopeId}for this resource.
Example filters for users
?filter=status:eq:active
?filter=last_name:ilike:%jansen%
?sort=last_name:ascExample request
curl -X GET "https://api.routix.com/v1/123e4567-e89b-12d3-a456-426614174000/users?limit=25&offset=0&sort=last_name:asc&filter=status:eq:active" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."Example response for v1
{
"data": [
{
"id": "e70d3a6a-799d-4a7d-88bd-0ad13f5211b4",
"first_name": "Sophie",
"last_name": "Jansen",
"email": "[email protected]",
"role_id": "planner",
"status": "active",
"organization_id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 1
},
"version": "v1"
}Fields
| Field | Description |
|---|---|
id | User UUID. |
first_name | User first name. |
last_name | User last name. |
email | User email address. |
role_id | User role or role ID. |
status | Current user status. |
organization_id | Organization UUID. |
Response format
Success: list response
{ "data": [], "pagination": { "limit": 50, "offset": 0, "total": 123 }, "version": "v1" }Error response
{
"error": "insufficient_scope",
"error_description": "Token does not contain the required scope for users"
}Related pages
- API integration
- API calls & examples
- Setup guide
Last updated on
