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 Enterprise API.
⚠️ This endpoint is disabled by default. Please contact the CareCloud administrator to allow usage of this method.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

count

integer

≥ 1

Defaults to 100

The number of records to return in API response.

⚠️ We recommend adjusting the batch size based on the response time of the request. The default value of 100 records is used if the 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

enum

Direction of sorting the response list.

Allowed:

string

^[-a-z0-9!#$%&'*+\\/=?^_`{|}~]+(\.[-a-z0-9!#$%&'*+\\/=?^_`{|}~]+)*@([a-z0-9]([-a-z0-9]{0,61}[a-z0-9])?\.)+[a-z0-9]([-a-z0-9]{0,61}[a-z0-9])$

Search by email. The value is validated against the email format: ^[-a-z0-9!#$%&'*+\\/=?^_{|}~]+(\.[-a-z0-9!#$%&'*+\/=?^_`{|}~]+)*@(a-z0-9?\.)+a-z0-9$`

phone

string

^[1-9][0-9]*$

Phone number of the customer with international prefix. Digits only, no leading zero. Example: 420523828931.

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. GET /stores

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

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

Responses

`error.error_data.invalid_params[]` array lists the parameters that caused the failure, each carrying a `reason` code. See the `BadRequestErrorBody` schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access an unauthorized property or resource.

404The request path does not match any API route, or the addressed resource does not exist.

405The request path matches a valid route, but the endpoint does not support the HTTP method used in the request.

500Server is not working as expected.