Skip to main content
GET
Lists roles for a company

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

page
integer

Page number for pagination

per_page
integer

Number of items per page (max 25)

sorted_by
string

Sort field and direction (e.g., 'name_asc', 'created_at_desc', 'users_asc', 'permissions_desc')

search_query
string

Search term to filter roles by name

max_user_count
integer

Maximum number of users assigned to roles (inclusive)

min_user_count
integer

Minimum number of users assigned to roles (inclusive)

Response

object | null

Success

roles
(object | null)[] | null

List of roles

meta
object | null