User roles

Available methods

All available methods for resource user-roles.

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

Get all user roles

[badge-blue GET] /user-roles
Get a list of all user roles 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

Response

Parameter name	Type	Description
users	UserRole[ ]	Array of user roles
total_items	integer	Count of all found user roles

Get information about an user role

Get information about a specific user role
[badge-blue GET] /user-roles/{user_role_id}

Path parameters

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

Response