Get tenant roles

GET /v1/tenants/{id}/roles/list

Get tenant roles

cURL

curl --request GET \
  --url https://staging.api.us.aptlydone.com/auth/v1/tenants/{id}/roles/list \
  --header 'Authorization: Bearer <token>'

200

{
  "statusCode": 200,
  "timestamp": "2026-01-12T09:10:12.794Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "955aa514-ab2c-4277-9b07-1e22761528b2",
        "roleName": "so through",
        "tenantId": "6d188158-b229-4acc-aea2-bae43e166f3a",
        "description": "noisily provided which hourly black supposing bourgeoisie meaty integer yarmulke",
        "isCustom": true,
        "canDeactivate": true,
        "status": "ACTIVE",
        "isDeleted": false,
        "deletedOn": "2025-04-01T19:45:37.028Z",
        "isDeactivated": false,
        "deactivatedOn": "2025-06-26T21:47:10.121Z",
        "createdOn": "2026-01-12T08:23:02.411Z",
        "updatedOn": "2026-01-12T07:18:22.373Z",
        "roleId": "10000",
        "usersCount": 7,
        "relationshipMappings": [
          {
            "relationshipKeyName": "create:documents",
            "isEnabled": true,
            "status": "ACTIVE"
          }
        ]
      }
    ]
  }
}

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 · string

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

Show child attributes