Users

Resource is available only in Enterprise interface.

Available methods

All available methods for resource users.

HTTP method Endpoint Description
[badge-blue GET ] /users Get a list of all users
[badge-blue GET ] /users/{user_id} Get information about a specific user

Actions

Action methods for resource users.

HTTP method Endpoint Description
[badge-green POST] /users/actions/verify-auth-token Verification of the authentitacion token


Get all users

[badge-blue GET] /users
Get a list of all users in CareCloud

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
email string Search users by email. No
phone string Search phone number of the user with international prefix (420000000) No
login string Search by login. No
first_name string Search by user first name No
last_name string Search by user last name No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
users User[ ] Array of users
total_items integer Count of all found users


Get information about an user

Get information about a specific user
[badge-blue GET] /users/{user_id}

Path parameters

Parameter name Type Description Mandatory (Yes/No)
user_id string The unique id of the user Yes

Response

Status code: 200 OK
Output structure : User


Verify user auth token

Verification of the user auth token
[badge-green POST] /users/actions/verify-auth-token

Request

Parameter name Type Description Mandatory (Yes/No)
auth_token string Authentication token for user verification Yes

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
user_id string The unique id of the user