List all Roles

1 min

GET

https://developer.digitail.io/api/v1/roles

Permissions needed: ACCESS_ADMINISTRATION_SETTINGS Returns the Role list. Filter by clinic_id or group_id. When filtering by clinic_id for an enterprise clinic, the response automatically includes both clinic-local roles AND enterprise group-level roles. Non-enterprise clinics see only their own clinic-local roles (unchanged behavior). When filtering by group_id, the response includes both group-level roles and the clinic-local roles of every clinic in the group (requires enterprise admin permissions).

filter[clinic_id]integerClinic ID. Returns clinic-local roles. For enterprise clinics, also includes group-level roles automatically. Required if filter[group_id] is not provided.

filter[group_id]integerEnterprise group ID. Returns group-level roles plus clinic-local roles for every clinic in the group. Required if filter[clinic_id] is not provided. Requires enterprise admin permissions.

includestringAdditional info to include. You can use multiple, comma separated. Options: vetPermissions,vetPermissions.permissionGroup,vetPermissions.permissionSubGroup.

acceptstringGenerated from available response content types

200successful operation

curl --request GET \
     --url https://developer.digitail.io/api/v1/roles \
     --header 'accept: application/json'