Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs
Accounts
Billing
Chat Channels
Chat Channels (Account-level)
Chat Messages
Chatbot Messages
Contacts
Cloud Recording
Dashboards
Devices
Groups
IM Chat
IM Groups
Meetings
PAC
Phone
Phone Auto Receptionists
Phone Blocked List
Phone Call Queues
Phone Devices
Phone Reports
Phone Shared Line Groups
Phone Site
Common Area Phones
Roles
Rooms
Rooms Account
Rooms Location
SIP Phone
TrackingField
TSP
Users
Webinars
Rooms Devices
SIP Connected Audio
Deprecated API Endpoints
Account Events
App Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Data Compliance
get

/report/users

A user is considered to be an active host during the month specified in the “from” and “to” range, if the user has hosted at least one meeting during this period. If the user didn’t host any meetings during this period, the user is considered to be inactive.
The Active Hosts report displays a list of meetings, participants, and meeting minutes for a specific time range, up to one month. The month should fall within the last six months.
The Inactive Hosts report pulls a list of users who were not active during a specific period of time. Use this API to retrieve an active or inactive host report for a specified period of time. The time range for the report is limited to a month and the month should fall under the past six months.
You can specify the type of report and date range using the query parameters.
Scopes: report:read:admin

Rate Limit Label: Heavy
Prerequisites:

  • Pro or higher plan.

Authorization

oauth2 - authorizationCode

Request Parameters

6 Query Parameters

Responses

HTTP Status Code: 200
Active or inactive hosts report returned.
This is only available for paid account: {accountId}.

1 Example
Schema
object
from
string

Start date for this report.

1 validation
to
string

End date for this report.

1 validation
page_count
integer

The number of pages returned for the request made.

page_number
integer

The page number of the current results.

1 validation
page_size
integer

The number of records returned with a single API call.

2 validations
total_records
integer

The total number of all the records available across pages.

next_page_token
string
total_meetings
integer

Number of meetings for this range.

total_participants
integer

Number of participants for this range.

total_meeting_minutes
integer

Number of meeting minutes for this range.

users
array[object]

Array of user objects.

Send a Test Request

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