Zoom Public API Documentation
Get meeting reports
GET {{baseUrl}}/report/users/:userId/meetings?from=<date>&to=<date>&page_size=30&next_page_token=<string>&type=past
Retrieve report on past meetings and webinars for a specified time period. The time range for the report is limited to a month and the month must fall within the past six months. Meetings and webinars are returned only if they have two or more unique participants. Prerequisites: Scopes: Rate Limit Label:
report:read:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
from
|
string | (Required) Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once. | |
to
|
string | (Required) End date. | |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
type
|
string | The meeting type to query for: * `past` — All past meetings. * `pastOne` — A single past user meeting. * `pastJoined` — All past meetings the account's users hosted or joined. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_count": "<integer>",
"page_number": 1,
"page_size": 30,
"total_records": "<integer>",
"from": "<date>",
"meetings": [
{
"custom_keys": [
{
"key": "<string>",
"value": "<string>"
},
{
"key": "<string>",
"value": "<string>"
}
],
"duration": "<integer>",
"end_time": "<dateTime>",
"id": "<integer>",
"participants_count": "<integer>",
"session_key": "<string>",
"source": "<string>",
"start_time": "<dateTime>",
"topic": "<string>",
"total_minutes": "<integer>",
"type": 4,
"user_email": "<email>",
"user_name": "<string>",
"uuid": "<string>",
"schedule_time": "<string>",
"join_waiting_room_time": "<string>",
"join_time": "<string>",
"leave_time": "<string>",
"host_organization": "<string>",
"host_name": "<string>",
"has_screen_share": "<boolean>",
"has_recording": "<boolean>",
"has_chat": "<boolean>",
"meeting_encryption_status": 2,
"participants_count_my_account": "<integer>"
},
{
"custom_keys": [
{
"key": "<string>",
"value": "<string>"
},
{
"key": "<string>",
"value": "<string>"
}
],
"duration": "<integer>",
"end_time": "<dateTime>",
"id": "<integer>",
"participants_count": "<integer>",
"session_key": "<string>",
"source": "<string>",
"start_time": "<dateTime>",
"topic": "<string>",
"total_minutes": "<integer>",
"type": 1,
"user_email": "<email>",
"user_name": "<string>",
"uuid": "<string>",
"schedule_time": "<string>",
"join_waiting_room_time": "<string>",
"join_time": "<string>",
"leave_time": "<string>",
"host_organization": "<string>",
"host_name": "<string>",
"has_screen_share": "<boolean>",
"has_recording": "<boolean>",
"has_chat": "<boolean>",
"meeting_encryption_status": 2,
"participants_count_my_account": "<integer>"
}
],
"to": "<date>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/report/users/:userId/meetings?from=<date>&to=<date>&page_size=30&next_page_token=<string>&type=past?from=<date>&to=<date>&page_size=30&next_page_token=<string>&type=past' -H 'Accept: application/json'
ENDPOINTS