Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Accounts
Archiving
Billing
Chat Channels
Chat Channels (Account-level)
Chat Messages
Contacts
Cloud Recording
Dashboards
Devices
Groups
IM Chat
IM Groups
Meetings
PAC
Reports
SIP Connected Audio
SIP Phone
Tracking Field
TSP
Users
Webinars
Zoom Rooms
Zoom Rooms Account
Zoom Rooms Location
Zoom Rooms Devices
Deprecated API Endpoints
Account
Audio Library
Auto Receptionists
Blocked List
Call Handling
Call Logs
Call Queues
Carrier Reseller
Common Area Phones
Dashboard
Devices
Directory Backup Routing Rules
Emergency Service Locations
External Contacts
IVR
Monitoring Groups
Phone Numbers
Provider Exchange
Recordings
Reports
Setting Templates
Settings
Shared Access
Shared Line Group
Site
SMS
Users
Voicemails
Zoom Rooms
Cloud Recording
Sessions
Archiving Events
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Video SDK Events
Zoom Room Events
Deprecated API Endpoints
get

/roles/{roleId}

Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list of privileges.

Use this API to get information including specific privileges assigned to a role.
Pre-requisite:

  • A Pro or higher plan.
  • For role management and updates, you must be the Account Owner or user with role management permissions.

Scopes: role:read:admin

Rate Limit Label: Light

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter

Responses

Status Code: 200
Information about a specific role returned.

Error Code: 200
You do not have the permission to retrieve role information.

Schema
object
id
string

Role Id.

name
string

Name of the role.

description
string

Description of the role.

total_members
integer

Total members assigned to that role.

privileges
array[string]

Privileges assigned to the role. Can be one or a combination of these permissions.

sub_account_privileges
object

This field will only be displayed to accounts that are enrolled in a partner plan and follow the master accounts and sub accounts structure.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
roleId
$$.env
1 variable not set
oauth_access_token