List Meetings
Use this API to list a user's (meeting host) scheduled meetings. For user-level apps, pass the me
value instead of the userId
parameter.
Note:
This API only supports scheduled meetings. This API does not return information about instant meetings.
This API only returns a user's unexpired meetings.
Scopes:
meeting:read:admin
,meeting:read
Rate Limit Label:Medium
.
Basic Parameters
Parameter | Description |
---|---|
Page Size | The number of records returned within a single API call. |
Return All Pages | Automatically fetch all resources, page by page. |
Type | The type of meeting: scheduled — All valid previous (unexpired) meetings, live meetings, and upcoming scheduled meetings. live — All the ongoing meetings. upcoming — All upcoming meetings, including live meetings. upcoming_meetings — All upcoming meetings, including live meetings. * previous_meetings — All the previous meetings. |
User ID | The user ID or email address of the user. For user-level apps, pass the me value. |
Advanced Parameters
Parameter | Description |
---|---|
Next Page Token | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
Page Number | The page number of the current page in the returned records. |
Example Output
{
"meetings": [
{
"agenda": "My Meeting",
"created_at": "2022-03-23T05:31:16Z",
"duration": 60,
"host_id": "30R7kT7bTIKSNUFEuH_Qlg",
"id": 97763643886,
"join_url": "https://example.com/j/11111",
"pmi": "97891943927",
"start_time": "2022-03-23T06:00:00Z",
"timezone": "America/Los_Angeles",
"topic": "My Meeting",
"type": 2,
"uuid": "aDYlohsHRtCd4ii1uC2+hA=="
}
],
"next_page_token": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 1
}
Workflow Library Example
List Meetings with Zoom and Send Results Via Email