v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB

Role Management

List Company User Roles

Returns a list of account user roles.

get/restapi/v1.0/account/{accountId}/user-role

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

Query parameters

customboolean

Specifies whether to return custom roles or predefined roles only. If not specified, all roles are returned

pageinteger

The result set page number (1-indexed) to return

perPageinteger

The number of items per page. If provided value in the request is greater than a maximum, the maximum value is applied

Response

List of account user roles

uristring uri

Example response

{
  "records": [
    {
      "displayName": "Super Admin",
      "description": "Primary company administrator role"
    }
  ],
  "paging": {
    "perPage": 50,
    "page": 5,
    "pageEnd": 5,
    "totalPages": 25,
    "totalElements": 25
  }
}