Roles
Search Roles
Search and list Role records with filtering, sorting, and pagination.
GET
Search Roles
A Role is a system-wide, read-only named permission definition used by UserRole permission groups to control user access across their accessible locations.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the Role-List role.Query Parameters
Pagination & Sorting
Filters
Range Filters
Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of Role records matching the query. See the Get one Role endpoint for the full list of properties returned for each record.
Example Response