Skip to main content
GET
Get tenant roles

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Query Parameters

page
number
default:1
required

Page number

limit
number
default:10
required

Number of items per page

Search term for role name or description

status
enum<string>

Role status filter

Available options:
ACTIVE,
INACTIVE
isCustom
boolean

Filter by custom/default roles

isDeactivated
boolean

Filter by deactivated status

sortBy
string

Field to sort by

Example:

"roleName"

sortOrder
enum<string>
default:asc

Sort order

Available options:
asc,
desc

Response

200 - application/json

Tenant roles list fetched successfully

statusCode
number
required
Example:

200

timestamp
string
required
Example:

"2026-01-12T09:10:12.794Z"

message
string
required
Example:

"Success"

data
object