Get all users
Get a list of all users in CareCloud. ⚠️ Endpoint is available only in the Enterprise interface. ⚠️ This endpoint is disabled by default. Please contact the CareCloud administrator to allow usage of this method.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
Search by email.
Phone number of the customer with international prefix (420000000000).
Search by login.
Search by first name.
Search by last name.
The unique ID of the store in CareCloud. GET /stores
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"users": [
{
"user_id": "838b73aacb5ac326cec4030c80",
"login": "happy_user",
"first_name": "Happy",
"last_name": "User",
"email": "happy_user@crmcarcloud.com",
"phone": "420523828931",
"user_role_ids": [
"86e05affc7a7befcd513ab400",
"89ce2a1b9b01f5c939fb1e20cd"
],
"store_id": "86e05affc7a7abecd513ab400",
"last_login": "2021-04-16 18:22:35.052987"
}
],
"total_items": 1
}
}