Zoom Public API Documentation
List archived files
GET {{baseUrl}}/archive_files?page_size=30&next_page_token=<string>&from=<dateTime>&to=<dateTime>&query_date_type=meeting_start_time&group_id=<string>
Get an account's archived meeting or webinar files. Zoom's archiving solution lets account administrators set up an automated mechanism to record, collect, and archive meeting data to a third-party platform of their choice to satisfy FINRA or other compliance requirements. Prerequisites:
* The Meeting and Webinar Archiving feature enabled for your account by Zoom Support. Scopes: Rate Limit Label: recording:read:adminMEDIUM
Body
PARAM
| Key | Datatype | Required | Description |
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. | |
from
|
string | The query start date, in `yyyy-MM-dd'T'HH:mm:ssZ` format. This value and the `to` query parameter value cannot exceed seven days. | |
to
|
string | The query end date, in `yyyy-MM-dd'T'HH:mm:ssZ` format. This value and the `from` query parameter value cannot exceed seven days. | |
query_date_type
|
string | The type of query date. * `meeting_start_time` * `archive_complete_time` This value defaults to `meeting_start_time`. | |
group_id
|
string | The group ID. To get a group ID, use the [List groups](https://developers.zoom.us/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"from": "<dateTime>",
"meetings": [
{
"account_name": "<string>",
"archive_files": [
{
"download_url": "<string>",
"encryption_fingerprint": "<string>",
"file_extension": "<string>",
"file_size": "<integer>",
"file_type": "CC",
"id": "<string>",
"individual": "<boolean>",
"participant_join_time": "<dateTime>",
"participant_leave_time": "<dateTime>",
"recording_type": "chat_message",
"status": "failed",
"file_path": "<string>",
"participant_email": "<email>",
"number_of_messages": "<integer>",
"storage_location": "CA",
"auto_delete": "<boolean>"
},
{
"download_url": "<string>",
"encryption_fingerprint": "<string>",
"file_extension": "<string>",
"file_size": "<integer>",
"file_type": "CHAT",
"id": "<string>",
"individual": "<boolean>",
"participant_join_time": "<dateTime>",
"participant_leave_time": "<dateTime>",
"recording_type": "audio_only",
"status": "completed",
"file_path": "<string>",
"participant_email": "<email>",
"number_of_messages": "<integer>",
"storage_location": "AU",
"auto_delete": "<boolean>"
}
],
"complete_time": {},
"duration": "<integer>",
"duration_in_second": "<integer>",
"host_id": "<string>",
"id": "<long>",
"is_breakout_room": "<boolean>",
"meeting_type": "external",
"recording_count": "<integer>",
"start_time": "<dateTime>",
"status": "processing",
"timezone": "<string>",
"topic": "<string>",
"total_size": "<integer>",
"type": 6,
"uuid": "<string>",
"parent_meeting_id": "<string>",
"group_id": "<string>"
},
{
"account_name": "<string>",
"archive_files": [
{
"download_url": "<string>",
"encryption_fingerprint": "<string>",
"file_extension": "<string>",
"file_size": "<integer>",
"file_type": "CC",
"id": "<string>",
"individual": "<boolean>",
"participant_join_time": "<dateTime>",
"participant_leave_time": "<dateTime>",
"recording_type": "chat_message",
"status": "completed",
"file_path": "<string>",
"participant_email": "<email>",
"number_of_messages": "<integer>",
"storage_location": "BR",
"auto_delete": "<boolean>"
},
{
"download_url": "<string>",
"encryption_fingerprint": "<string>",
"file_extension": "<string>",
"file_size": "<integer>",
"file_type": "CC",
"id": "<string>",
"individual": "<boolean>",
"participant_join_time": "<dateTime>",
"participant_leave_time": "<dateTime>",
"recording_type": "audio_only",
"status": "completed",
"file_path": "<string>",
"participant_email": "<email>",
"number_of_messages": "<integer>",
"storage_location": "IN",
"auto_delete": "<boolean>"
}
],
"complete_time": {},
"duration": "<integer>",
"duration_in_second": "<integer>",
"host_id": "<string>",
"id": "<long>",
"is_breakout_room": "<boolean>",
"meeting_type": "internal",
"recording_count": "<integer>",
"start_time": "<dateTime>",
"status": "processing",
"timezone": "<string>",
"topic": "<string>",
"total_size": "<integer>",
"type": 8,
"uuid": "<string>",
"parent_meeting_id": "<string>",
"group_id": "<string>"
}
],
"next_page_token": "<string>",
"page_size": "<integer>",
"to": "<dateTime>",
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/archive_files?page_size=30&next_page_token=<string>&from=<dateTime>&to=<dateTime>&query_date_type=meeting_start_time&group_id=<string>?page_size=30&next_page_token=<string>&from=<dateTime>&to=<dateTime>&query_date_type=meeting_start_time&group_id=<string>' -H 'Accept: application/json'
ENDPOINTS