Get all user roles
Get a list of all user roles in CareCloud. ⚠️ Endpoint is available only in the Enterprise interface.
Request
- Base URLhttps://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0
- Auth
- HTTP bearer
- or HTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
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.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"user_roles": [
{
"user_role_id": "86e05affc7a7befcd513ab400",
"name": "Cashdesk"
}
],
"total_items": 1
}
}Changes
No recorded changes to this operation across all 1 revision of this API.