# Retrieve list of all role details

Retrieves a paginated list of all roles configured in the system, including role names, descriptions, and creation timestamps. Supports page-based pagination via the `page` and `pageLimit` parameters.

## Endpoints

`GET /emsapi/roles/details`

## Request

### Request URL

`https://[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/emsapi/roles/details`

### Scope

`DesktopCentralCloud.Admin.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Query Parameters

- **page** `integer` *(Optional)*: Page number for pagination. Starts from 1. Returns the first page if not specified.
- **pageLimit** `integer` *(Optional)*: Maximum number of role records to return per page. Uses system default if not specified. Value can be upto 1000.

### Sample Request

```curl
curl --request GET \
  --url https://appdomains/emsapi/roles/details \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response

### HTTP 200

Response Body — `application/json`

- `JSON Object`
  - **metadata** `JSON Object`: Pagination metadata for the current page.
  - **totalRecords** `string`: Total number of role records available in the system.
  - **messageResponse** `JSON Array`: List of role details returned for the current page.
  - **totalPages** `long`: Total number of pages available for the given page limit.
  - **Links** `JSON Object`: Pagination links for navigating to the next and previous pages.
  - **status** `string`: Response status. `'success'` indicates the role list was fetched successfully.

### Possible Response Codes

- **200** `HTTP code`

### Sample Response: HTTP 200

Paginated list response for role details with metadata and navigation links.

```json
{
  "metadata": {
    "limit": 25,
    "page": 1
  },
  "totalRecords": "5",
  "messageResponse": [
    {
      "creation_time": "Nov 3, 2025 12:15 PM",
      "modified_time": "Nov 3, 2025 12:15 PM",
      "um_role_id": "1",
      "is_editable": "false",
      "um_role_name": "Security Auditor",
      "um_role_description": "Read-only access for audit and compliance review.",
      "admin_name": "System Administrator"
    },
    {
      "creation_time": "Nov 3, 2025 12:15 PM",
      "modified_time": "Nov 3, 2025 12:15 PM",
      "um_role_id": "4",
      "is_editable": "true",
      "um_role_name": "Endpoint Technician",
      "um_role_description": "Operational access for routine endpoint management tasks.",
      "admin_name": "System Administrator"
    },
    {
      "creation_time": "Nov 3, 2025 12:15 PM",
      "modified_time": "Nov 3, 2025 12:15 PM",
      "um_role_id": "3",
      "is_editable": "false",
      "um_role_name": "Patch Administrator",
      "um_role_description": "Full access to patch deployment and remediation workflows.",
      "admin_name": "System Administrator"
    },
    {
      "creation_time": "Nov 3, 2025 12:15 PM",
      "modified_time": "Nov 3, 2025 12:15 PM",
      "um_role_id": "6",
      "is_editable": "true",
      "um_role_name": "Asset Analyst",
      "um_role_description": "Read-only access to inventory and asset insights.",
      "admin_name": "System Administrator"
    },
    {
      "creation_time": "Nov 3, 2025 12:15 PM",
      "modified_time": "Nov 3, 2025 12:15 PM",
      "um_role_id": "2",
      "is_editable": "true",
      "um_role_name": "Service Desk Operator",
      "um_role_description": "Limited operational access for help desk support tasks.",
      "admin_name": "System Administrator"
    }
  ],
  "totalPages": 1,
  "Links": {
    "next": null,
    "prev": null
  },
  "status": "success"
}
```

Page 2 result when multiple pages exist. Shows pagination with next and previous links populated.

```json
{
  "metadata": {
    "limit": 3,
    "page": 2
  },
  "totalRecords": "8",
  "messageResponse": [
    {
      "creation_time": "Nov 5, 2025 02:30 PM",
      "modified_time": "Nov 5, 2025 02:30 PM",
      "um_role_id": "7",
      "is_editable": "true",
      "um_role_name": "Network Administrator",
      "um_role_description": "Full access to network management and configuration.",
      "admin_name": "System Administrator"
    },
    {
      "creation_time": "Nov 6, 2025 10:15 AM",
      "modified_time": "Nov 6, 2025 10:15 AM",
      "um_role_id": "8",
      "is_editable": "true",
      "um_role_name": "Software Deployment Manager",
      "um_role_description": "Manage software deployment and updates across all endpoints.",
      "admin_name": "System Administrator"
    },
    {
      "creation_time": "Nov 7, 2025 03:45 PM",
      "modified_time": "Nov 7, 2025 03:45 PM",
      "um_role_id": "9",
      "is_editable": "false",
      "um_role_name": "Read-Only User",
      "um_role_description": "View-only access to all modules without modification rights.",
      "admin_name": "System Administrator"
    }
  ],
  "totalPages": 3,
  "Links": {
    "next": "/emsapi/roles/details?page=3&limit=3",
    "prev": "/emsapi/roles/details?page=1&limit=3"
  },
  "status": "success"
}
```

## Rate Limits

**Duration:** 1 minute | **Threshold:** 30 | **Lock period:** 5 minutes

Duration - Time window for the threshold.  
Threshold - Number of API calls allowed within the specified duration.  
Lock Period - Wait time before consecutive API requests.