Basic Parameters
| Parameter | Description |
|---|---|
| Per Page | Number of results per page, valid range is 1-100. |
| Query | Full text query string, search in firstname, lastname and email. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Active | If true, returns only the users who have logged in on the platform at least once. |
| Search by email (exact). | |
| External ID | Search by external ID (exact). |
| Firstname | Search by firstname (exact). |
| Lastname | Search by lastname (exact). |
| Organization ID | Returns the users who have a profile linked to this organization. |
| Role ID | Returns all the users who have this role. |
Example Output
[
{
"external_id": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"email": "string",
"language": "string",
"timezone": "string",
"mobile_phone_number": "string",
"profiles": [
{
"role_id": "string",
"employees_perimeter": {
"operator": "=",
"organization_id": "string",
"organization_group_id": "string",
"custom_field_filters": [
{
"custom_field_id": "string",
"operator": "=",
"value": "string"
}
]
},
"id": "string"
}
],
"id": "string",
"created_at": "2023-11-13T19:38:53.991Z",
"updated_at": "2023-11-13T19:38:53.991Z"
}
]