Get all users

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/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 Params

count

integer

≥ 1

Defaults to 100

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.

offset

integer

≥ 0

Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_field

string

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.

sort_direction

string

Direction of sorting the response list.

string

Search by email.

phone

string

Phone number with international prefix (420000000).

string

Search by login.

first_name

string

Search by first name.

last_name

string

Search by last name.

store_id

string

The unique ID of the store in CareCloud.

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/users?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
21
 
1
{
2
  "data": {
3
    "users": [
4
      {
5
        "user_id": "838b73aacb5ac326cec4030c80",
6
        "login": "happy_user",
7
        "first_name": "Happy",
8
        "last_name": "User",
9
        "email": "happy_user@crmcarcloud.com",
10
        "phone": "420523828931",
11
        "user_role_ids": [
12
          "86e05affc7a7befcd513ab400",
13
          "89ce2a1b9b01f5c939fb1e20cd"
14
        ],
15
        "store_id": "86e05affc7a7abecd513ab400",
16
        "last_login": "2021-04-16 18:22:35.052987"
17
      }
18
    ],
19
    "total_items": 1
20
  }
21
}

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.