GET
/
v1
/
tenants
/
{id}
/
roles
/
list
Get tenant roles
curl --request GET \
  --url https://staging.api.us.aptlydone.com/auth/v1/tenants/{id}/roles/list \
  --header 'Authorization: Bearer <token>'
{
  "statusCode": 200,
  "timestamp": "2025-06-25T06:16:48.711Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "0b40809b-b83d-4947-b94e-4ee26c8df225",
        "roleName": "illiterate warped",
        "tenantId": "f77ba387-8832-407e-a496-c6e7f0d1cae8",
        "description": "oof er hence owlishly because absentmindedly airline indeed famously weight",
        "isCustom": true,
        "canDeactivate": false,
        "status": "ACTIVE",
        "isDeleted": false,
        "deletedOn": "2024-08-24T03:30:00.957Z",
        "isDeactivated": false,
        "deactivatedOn": "2024-11-16T03:01:37.255Z",
        "createdOn": "2025-06-24T19:32:41.810Z",
        "updatedOn": "2025-06-25T00:56:51.216Z",
        "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 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

The response is of type object.