Go to appAcademyWhat's new?
Back
Artisan IMG > Zoom (zoom) (72a0b340-4c94-465d-863a-e83b403cd1b6)
Zoom
OverviewOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

Add meeting registrants
Copy

Register a participant for a meeting.

Sample Input

1
{
2
    "meeting_id": "123456789",
3
    "email": "john.doe@example.com",
4
    "first_name": "John",
5
    "last_name": "Doe",
6
    "occurrence_ids": [
7
        1,
8
        2,
9
        3
10
    ],
11
    "address": "123 Main St",
12
    "city": "New York",
13
    "country": "USA",
14
    "zip": "10001",
15
    "state": "NY",
16
    "phone": "+1 555-123-4567",
17
    "industry": "Technology",
18
    "org": "Tech Corp",
19
    "job_title": "Software Engineer",
20
    "purchasing_time_frame": "1-3 months",
21
    "role_in_purchase_process": "Evaluator/Recommender",
22
    "no_of_employees": "101-500",
23
    "comments": "Looking forward to the meeting!",
24
    "custom_questions": [
25
        {
26
            "title": "What topics are you most interested in?",
27
            "value": "AI and Machine Learning"
28
        }
29
    ]
30
}

Sample Output

1
{
2
    "registrant_id": "abcdef123456",
3
    "id": 987654321,
4
    "topic": "Quarterly Tech Update",
5
    "start_time": "2023-06-15T14:00:00Z",
6
    "join_url": "https://zoom.us/j/123456789?pwd=abcdefghijklmnop"
7
}

Create meeting
Copy

Create a meeting for a user.

Sample Input

1
{
2
    "user_id": "john.doe@example.com",
3
    "topic": "Weekly Team Meeting",
4
    "type": 2,
5
    "start_time": "2023-06-15T14:00:00Z",
6
    "duration": 60,
7
    "password": "meet123*",
8
    "agenda": "Discuss project progress and upcoming deadlines",
9
    "settings": {
10
        "host_video": true,
11
        "participant_video": true,
12
        "join_before_host": false,
13
        "mute_upon_entry": true,
14
        "watermark": false,
15
        "audio": "both",
16
        "auto_recording": "cloud",
17
        "waiting_room": true
18
    }
19
}

Sample Output

1
{
2
    "settings": {
3
        "host_video": true,
4
        "participant_video": true,
5
        "cn_meeting": false,
6
        "in_meeting": false,
7
        "join_before_host": false,
8
        "mute_upon_entry": true,
9
        "watermark": false,
10
        "use_pmi": false,
11
        "approval_type": 2,
12
        "audio": "both",
13
        "auto_recording": "cloud",
14
        "enforce_login": false,
15
        "waiting_room": true,
16
        "registrants_confirmation_email": true,
17
        "global_dial_in_countries": [
18
            "US",
19
            "CA",
20
            "GB"
21
        ],
22
        "global_dial_in_numbers": [
23
            {
24
                "country_name": "United States",
25
                "city": "New York",
26
                "number": "+1 1234567890",
27
                "type": "toll",
28
                "country": "US"
29
            }
30
        ]
31
    },
32
    "start_time": "2023-06-15T14:00:00Z",
33
    "created_at": "2023-06-10T09:30:15Z",
34
    "topic": "Weekly Team Meeting",
35
    "start_url": "https://zoom.us/s/1234567890?zak=eyJ6bV9za20iOiJ6bV9vMm0iLCJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
36
    "join_url": "https://zoom.us/j/1234567890",
37
    "host_id": "AbCdEfGhIjK",
38
    "status": "waiting",
39
    "duration": 60,
40
    "timezone": "America/New_York",
41
    "type": 2,
42
    "id": 1234567890,
43
    "uuid": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456"
44
}

Create users
Copy

Add a new user to your account

Sample Input

1
{
2
    "user_type": 2,
3
    "email": "johndoe@example.com",
4
    "first_name": "John",
5
    "last_name": "Doe"
6
}

Sample Output

1
{
2
    "id": "abc123xyz456",
3
    "first_name": "John",
4
    "last_name": "Doe",
5
    "email": "johndoe@example.com",
6
    "type": 2
7
}

Create webinar
Copy

Create a webinar for a user.

Sample Input

1
{
2
    "user_id": "abc123",
3
    "topic": "Introduction to Cloud Computing",
4
    "webinar_type": 5,
5
    "start_time": "2023-06-15T14:00:00Z",
6
    "duration": 60,
7
    "password": "cloud123",
8
    "agenda": "In this webinar, we will cover the basics of cloud computing, its benefits, and popular cloud service providers.",
9
    "tracking_fields": [
10
        {
11
            "field": "Department",
12
            "value": "IT"
13
        }
14
    ],
15
    "settings": {
16
        "host_video": true,
17
        "panelist_video": true,
18
        "practice_session": true,
19
        "hd_video": true,
20
        "approval_type": "0",
21
        "audio": "both",
22
        "auto_recording": "cloud",
23
        "alternative_hosts": [
24
            "johndoe@example.com"
25
        ],
26
        "close_registration": false,
27
        "show_share_button": true,
28
        "allow_multiple_devices": true,
29
        "on_demand": false,
30
        "contact_name": "Jane Smith",
31
        "contact_email": "janesmith@example.com",
32
        "registrants_email_notification": true,
33
        "meeting_authentication": true
34
    }
35
}

Sample Output

1
{
2
    "uuid": "abcdef123456",
3
    "id": 987654321,
4
    "host_id": "xyz789",
5
    "host_email": "host@example.com",
6
    "topic": "Introduction to Cloud Computing",
7
    "type": 5,
8
    "start_time": "2023-06-15T14:00:00Z",
9
    "duration": 60,
10
    "timezone": "America/New_York",
11
    "agenda": "In this webinar, we will cover the basics of cloud computing, its benefits, and popular cloud service providers.",
12
    "created_at": "2023-05-20T10:30:00Z",
13
    "start_url": "https://zoom.us/s/987654321?zak=eyJ0eXAiOiJKV1QiLCJzdiI6IjAwMDAwMSIsInptX3NrbSI6InptX28ybSIsImFsZyI6IkhTMjU2In0.eyJhdWQiOiJjbGllbnRzbSIsInVpZCI6Il9fQ0hBVE9QRVJBVE9SX18iLCJpc3MiOiJ3ZWIiLCJzdHkiOjEwMCwid2NkIjoiYXcxIiwiY2x0IjowLCJtbnVtIjoiOTg3NjU0MzIxIiwic3RrIjoiQUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVowMTIzNDU2Nzg5IiwiZXhwIjoxNjIzNzYwODAwLCJpYXQiOjE2MjM3NTM2MDAsImFpZCI6Il9fQ0hBVE9QRVJBVE9SX18iLCJjaWQiOiIifQ.qxrFrg6ZmZxGc3Tr8qKxrI3_ydCn4q6jWKIHbaSIVME",
14
    "join_url": "https://zoom.us/j/987654321",
15
    "registration_url": "https://zoom.us/webinar/register/WN_abcdefghijklmnop",
16
    "password": "cloud123",
17
    "settings": {
18
        "host_video": true,
19
        "panelists_video": true,
20
        "approval_type": 0,
21
        "audio": "both",
22
        "auto_recording": "cloud",
23
        "enforce_login": false,
24
        "enforce_login_domains": "",
25
        "alternative_hosts": "johndoe@example.com",
26
        "close_registration": false,
27
        "show_share_button": true,
28
        "allow_multiple_devices": true,
29
        "practice_session": true,
30
        "hd_video": true,
31
        "question_answer": true,
32
        "registrants_confirmation_email": true,
33
        "on_demand": false,
34
        "request_permission_to_unmute_participants": false,
35
        "global_dial_in_countries": [
36
            "US",
37
            "CA",
38
            "GB"
39
        ],
40
        "global_dial_in_numbers": [
41
            {
42
                "country_name": "United States",
43
                "number": "+1 6465588656",
44
                "type": "toll",
45
                "country": "US"
46
            }
47
        ],
48
        "contact_name": "Jane Smith",
49
        "contact_email": "janesmith@example.com",
50
        "registrants_restrict_number": 1000,
51
        "registrants_email_notification": true,
52
        "post_webinar_survey": false,
53
        "survey_url": "",
54
        "meeting_authentication": true,
55
        "authentication_option": "zoom_authentication",
56
        "authentication_name": "",
57
        "authentication_domains": ""
58
    }
59
}

Create webinar registrant
Copy

Register a participant for a webinar.

Sample Input

1
{
2
    "user_id": "john.doe@example.com",
3
    "webinar_id": "123456789",
4
    "email": "jane.smith@example.com",
5
    "first_name": "Jane",
6
    "last_name": "Smith",
7
    "occurrence_ids": [
8
        "987654321",
9
        "876543210"
10
    ],
11
    "address": "123 Main St",
12
    "city": "New York",
13
    "country": "United States",
14
    "zip": "10001",
15
    "state": "NY",
16
    "phone": "+1-555-123-4567",
17
    "industry": "Technology",
18
    "org": "Tech Solutions Inc.",
19
    "job_title": "Software Engineer",
20
    "purchasing_time_frame": "1-3 months",
21
    "role_in_purchase_process": "Evaluator/Recommender",
22
    "no_of_employees": "101-500",
23
    "comments": "Interested in learning more about your product features.",
24
    "custom_questions": [
25
        {
26
            "title": "How did you hear about us?",
27
            "value": "Through a colleague"
28
        },
29
        {
30
            "title": "What's your primary interest in our webinar?",
31
            "value": "Product demonstration"
32
        }
33
    ]
34
}

Sample Output

1
{
2
    "registrant_id": "abcdef123456",
3
    "id": 987654321,
4
    "topic": "Introduction to Our New Product",
5
    "start_time": "2023-06-15T14:00:00Z",
6
    "join_url": "https://zoom.us/w/123456789?tk=abcdefghijklmnop"
7
}

Delete user
Copy

Delete a user from your account.

Sample Input

1
{
2
    "user_id": "john.doe@example.com",
3
    "action": "delete",
4
    "transfer_email": "jane.smith@example.com",
5
    "transfer_meeting": true,
6
    "transfer_recording": true,
7
    "transfer_webinar": false
8
}

Sample Output

1
{
2
    "success": true
3
}

Get account call logs
Copy

Retrieve an account's call logs.

Sample Input

1
{
2
    "date_range": {
3
        "from": "2023-05-01T00:00:00Z",
4
        "to": "2023-05-31T23:59:59Z"
5
    },
6
    "call_type": "all",
7
    "time_type": "startTime",
8
    "path": "extension",
9
    "site_id": "abc123",
10
    "page_size": 30,
11
    "next_page_token": ""
12
}

Sample Output

1
{
2
    "page_count": 3,
3
    "page_number": 1,
4
    "page_size": 30,
5
    "total_records": 75,
6
    "from": "2023-05-01T00:00:00Z",
7
    "to": "2023-05-31T23:59:59Z",
8
    "call_logs": [
9
        {
10
            "id": "123456789",
11
            "call_type": "voice",
12
            "caller_number": "+14155551234",
13
            "caller_number_type": "internal",
14
            "caller_name": "John Doe",
15
            "callee_number": "+14155555678",
16
            "callee_number_type": "external",
17
            "callee_name": "Jane Smith",
18
            "direction": "outbound",
19
            "duration": 300,
20
            "result": "completed",
21
            "date_time": "2023-05-15T14:30:00Z",
22
            "owner": {
23
                "type": "user",
24
                "id": "user123",
25
                "name": "John Doe",
26
                "extension_number": 1001
27
            }
28
        }
29
    ]
30
}

Get cloud recording report
Copy

Retrieves cloud recording usage report for a specified period.

Sample Input

1
{
2
    "from": "2023-05-01T00:00:00Z",
3
    "to": "2023-05-31T23:59:59Z"
4
}

Sample Output

1
{
2
    "from": "2023-05-01T00:00:00Z",
3
    "to": "2023-05-31T23:59:59Z",
4
    "cloud_recording_storage": [
5
        {
6
            "date": "2023-05-01",
7
            "usage": "1.5 GB",
8
            "plan_usage": "1.2 GB",
9
            "free_usage": "0.3 GB"
10
        },
11
        {
12
            "date": "2023-05-02",
13
            "usage": "2.1 GB",
14
            "plan_usage": "1.8 GB",
15
            "free_usage": "0.3 GB"
16
        },
17
        {
18
            "date": "2023-05-03",
19
            "usage": "1.8 GB",
20
            "plan_usage": "1.5 GB",
21
            "free_usage": "0.3 GB"
22
        }
23
    ]
24
}

Get daily usage report
Copy

Retrieves daily report to access the account-wide usage of Zoom services for each day in a given month.

Sample Input

1
{
2
    "year": 2023,
3
    "month": 5
4
}

Sample Output

1
{
2
    "year": 2023,
3
    "month": 5,
4
    "dates": [
5
        {
6
            "date": "2023-05-01",
7
            "new_users": 3,
8
            "meetings": 45,
9
            "participants": 178,
10
            "meeting_minutes": 2340
11
        },
12
        {
13
            "date": "2023-05-02",
14
            "new_users": 1,
15
            "meetings": 52,
16
            "participants": 205,
17
            "meeting_minutes": 2860
18
        },
19
        {
20
            "date": "2023-05-03",
21
            "new_users": 2,
22
            "meetings": 48,
23
            "participants": 192,
24
            "meeting_minutes": 2520
25
        }
26
    ]
27
}

Get meeting poll report
Copy

Retrieve a report of results for a past meeting.

Sample Input

1
{
2
    "meeting_id": "123456789"
3
}

Sample Output

1
{
2
    "id": 123456789,
3
    "uuid": "abcdef12-3456-7890-abcd-ef1234567890",
4
    "start_time": "2023-05-15T14:30:00Z",
5
    "questions": [
6
        {
7
            "name": "Poll 1",
8
            "question_details": [
9
                {
10
                    "question": "What is your favorite color?",
11
                    "answer": "Blue"
12
                },
13
                {
14
                    "question": "How satisfied are you with the meeting?",
15
                    "answer": "Very satisfied"
16
                }
17
            ]
18
        },
19
        {
20
            "name": "Poll 2",
21
            "question_details": [
22
                {
23
                    "question": "Do you prefer in-person or virtual meetings?",
24
                    "answer": "Virtual"
25
                }
26
            ]
27
        }
28
    ]
29
}

Get meeting recordings
Copy

Get all the recordings from a meeting.

Sample Input

1
{
2
    "meeting_id": "123456789"
3
}

Sample Output

1
{
2
    "uuid": "abcdef12-3456-7890-abcd-ef1234567890",
3
    "id": 987654321,
4
    "account_id": "ABC123DEF456",
5
    "host_id": "XYZ987UVW654",
6
    "topic": "Weekly Team Meeting",
7
    "type": 2,
8
    "start_time": "2023-05-15T14:00:00Z",
9
    "timezone": "America/New_York",
10
    "duration": 60,
11
    "total_size": 256000000,
12
    "recording_count": 2,
13
    "share_url": "https://zoom.us/rec/share/abcdefghijklmnop",
14
    "recording_files": [
15
        {
16
            "id": "rec123456",
17
            "meeting_id": "123456789",
18
            "recording_start": "2023-05-15T14:00:05Z",
19
            "recording_end": "2023-05-15T14:30:00Z",
20
            "file_type": "MP4",
21
            "file_size": 150000000,
22
            "play_url": "https://zoom.us/rec/play/abcdefghijklmnop",
23
            "download_url": "https://zoom.us/rec/download/abcdefghijklmnop",
24
            "status": "completed",
25
            "recording_type": "shared_screen_with_speaker_view"
26
        },
27
        {
28
            "id": "rec789012",
29
            "meeting_id": "123456789",
30
            "recording_start": "2023-05-15T14:30:05Z",
31
            "recording_end": "2023-05-15T15:00:00Z",
32
            "file_type": "MP4",
33
            "file_size": 106000000,
34
            "play_url": "https://zoom.us/rec/play/qrstuvwxyzabcdef",
35
            "download_url": "https://zoom.us/rec/download/qrstuvwxyzabcdef",
36
            "status": "completed",
37
            "recording_type": "shared_screen_with_speaker_view"
38
        }
39
    ]
40
}

Get meeting report
Copy

Get a detailed report for a past meeting.

Sample Input

1
{
2
    "meeting_id": "123456789"
3
}

Sample Output

1
{
2
    "uuid": "abcdef12-3456-7890-abcd-ef1234567890",
3
    "id": 987654321,
4
    "host_id": "hst123AbC",
5
    "type": 2,
6
    "topic": "Quarterly Team Meeting",
7
    "user_name": "John Doe",
8
    "user_email": "john.doe@example.com",
9
    "start_time": "2023-05-15T14:00:00Z",
10
    "end_time": "2023-05-15T15:30:00Z",
11
    "duration": 90,
12
    "total_minutes": 90,
13
    "participants_count": 15,
14
    "tracking_fields": []
15
}

Get users call logs
Copy

Retrieve a user's call logs.

Sample Input

1
{
2
    "phone_user_id": "user123",
3
    "date_range": {
4
        "from": "2023-05-01T00:00:00Z",
5
        "to": "2023-05-31T23:59:59Z"
6
    },
7
    "call_type": "all",
8
    "phone_number": "+14155551234",
9
    "time_type": "startTime",
10
    "page_size": 30,
11
    "next_page_token": ""
12
}

Sample Output

1
{
2
    "page_count": 2,
3
    "page_number": 1,
4
    "page_size": 30,
5
    "total_records": 45,
6
    "from": "2023-05-01T00:00:00Z",
7
    "to": "2023-05-31T23:59:59Z",
8
    "call_logs": [
9
        {
10
            "id": "call123",
11
            "call_type": "inbound",
12
            "caller_number": "+14155551234",
13
            "caller_number_type": "external",
14
            "caller_name": "John Doe",
15
            "callee_number": "+14155555678",
16
            "callee_number_type": "internal",
17
            "callee_name": "Jane Smith",
18
            "direction": "inbound",
19
            "duration": 300,
20
            "result": "answered",
21
            "date_time": "2023-05-15T14:30:00Z"
22
        },
23
        {
24
            "id": "call124",
25
            "call_type": "outbound",
26
            "caller_number": "+14155555678",
27
            "caller_number_type": "internal",
28
            "caller_name": "Jane Smith",
29
            "callee_number": "+14155559876",
30
            "callee_number_type": "external",
31
            "callee_name": "Bob Johnson",
32
            "direction": "outbound",
33
            "duration": 180,
34
            "result": "completed",
35
            "date_time": "2023-05-16T10:15:00Z"
36
        }
37
    ]
38
}

Get users profile
Copy

Retrieve a user's Zoom phone profile information.

Sample Input

1
{
2
    "phone_user_id": "abcdef123456"
3
}

Sample Output

1
{
2
    "id": "abcdef123456",
3
    "phone_user_id": "abcdef123456",
4
    "email": "john.doe@example.com",
5
    "extension_number": 1001,
6
    "calling_plans": [
7
        {
8
            "type": 1
9
        },
10
        {
11
            "type": 2
12
        }
13
    ],
14
    "phone_numbers": [
15
        {
16
            "id": "pn123456",
17
            "number": "+14155551234"
18
        },
19
        {
20
            "id": "pn789012",
21
            "number": "+14155555678"
22
        }
23
    ],
24
    "site_id": "site789",
25
    "status": "active",
26
    "policy": {
27
        "international_calling": true
28
    }
29
}

Get users report
Copy

Retrieves an active or inactive users report for a specified period of time.

Sample Input

1
{
2
    "from": "2023-05-01T00:00:00Z",
3
    "to": "2023-05-31T23:59:59Z",
4
    "user_status": "active",
5
    "page_size": 50,
6
    "page_number": 1
7
}

Sample Output

1
{
2
    "from": "2023-05-01T00:00:00Z",
3
    "to": "2023-05-31T23:59:59Z",
4
    "page_count": 3,
5
    "page_number": 1,
6
    "page_size": 50,
7
    "total_records": 125,
8
    "total_meetings": 450,
9
    "total_participants": 1800,
10
    "total_meeting_minutes": 27000,
11
    "users": [
12
        {
13
            "id": "abc123",
14
            "email": "john.doe@example.com",
15
            "user_name": "John Doe",
16
            "type": 2,
17
            "dept": "Sales",
18
            "meetings": 15,
19
            "participants": 60,
20
            "meeting_minutes": 900,
21
            "last_client_version": "5.13.5.12456",
22
            "last_login_time": "2023-05-31T14:30:00Z",
23
            "create_time": "2022-01-15T09:00:00Z"
24
        },
25
        {
26
            "id": "def456",
27
            "email": "jane.smith@example.com",
28
            "user_name": "Jane Smith",
29
            "type": 1,
30
            "dept": "Marketing",
31
            "meetings": 10,
32
            "participants": 40,
33
            "meeting_minutes": 600,
34
            "last_client_version": "5.13.5.12456",
35
            "last_login_time": "2023-05-30T16:45:00Z",
36
            "create_time": "2022-03-01T10:30:00Z"
37
        }
38
    ]
39
}

Get webinar
Copy

Retrieves a specific webinar.

Sample Input

1
{
2
    "webinar_id": "123456789"
3
}

Sample Output

1
{
2
    "settings": {
3
        "close_registration": false,
4
        "auto_recording": "cloud",
5
        "global_dial_in_numbers": [
6
            {
7
                "country_name": "United States",
8
                "city": "New York",
9
                "number": "+1 6465588656",
10
                "type": "toll",
11
                "country": "US"
12
            }
13
        ],
14
        "host_video": true,
15
        "allow_multiple_devices": true,
16
        "panelists_video": true,
17
        "registrants_confirmation_email": true,
18
        "contact_name": "John Doe",
19
        "on_demand": false,
20
        "enforce_login": false,
21
        "global_dial_in_countries": [
22
            "US",
23
            "CA",
24
            "UK"
25
        ],
26
        "practice_session": true,
27
        "show_share_button": true,
28
        "registrants_restrict_number": 100,
29
        "approval_type": 0,
30
        "audio": "both",
31
        "question_answer": true,
32
        "hd_video": true,
33
        "alternative_hosts": "jane@example.com",
34
        "enforce_login_domains": "",
35
        "contact_email": "john@example.com"
36
    },
37
    "start_time": "2023-06-15T14:00:00Z",
38
    "created_at": "2023-05-01T10:30:00Z",
39
    "agenda": "Discussing new product features and Q&A session",
40
    "topic": "Product Launch Webinar",
41
    "start_url": "https://zoom.us/s/123456789?zak=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
42
    "host_id": "h5Hd8fJ9Q7OxXzxjhTlNxQ",
43
    "duration": 60,
44
    "timezone": "America/New_York",
45
    "join_url": "https://zoom.us/j/123456789",
46
    "type": 5,
47
    "id": 123456789,
48
    "password": "123456",
49
    "uuid": "pNxQh5Hd8fJ9Q7OxXzxjhTl=="
50
}

Get webinar polls report
Copy

Retrieves a report on past webinar polls.

Sample Input

1
{
2
    "webinar_id": "123456789"
3
}

Sample Output

1
{
2
    "id": 987654321,
3
    "uuid": "abcdef12-3456-7890-ghij-klmnopqrstuv",
4
    "start_time": "2023-05-15T14:30:00Z",
5
    "questions": [
6
        {
7
            "name": "John Doe",
8
            "email": "johndoe@example.com",
9
            "question_details": [
10
                {
11
                    "question": "What is your favorite feature of our product?",
12
                    "answer": "The user-friendly interface"
13
                },
14
                {
15
                    "question": "How likely are you to recommend our product to others?",
16
                    "answer": "Very likely"
17
                }
18
            ]
19
        },
20
        {
21
            "name": "Jane Smith",
22
            "email": "janesmith@example.com",
23
            "question_details": [
24
                {
25
                    "question": "How often do you use our product?",
26
                    "answer": "Daily"
27
                },
28
                {
29
                    "question": "What improvements would you suggest for our product?",
30
                    "answer": "More integrations with other tools"
31
                }
32
            ]
33
        }
34
    ]
35
}

Get webinar Q&A report
Copy

Retrieves a report on question and answers from past webinars.

Sample Input

1
{
2
    "webinar_id": "123456789"
3
}

Sample Output

1
{
2
    "id": 123456789,
3
    "uuid": "abcdef123456ghijkl789012",
4
    "start_time": "2023-05-15T14:00:00Z",
5
    "questions": [
6
        {
7
            "name": "John Doe",
8
            "email": "johndoe@example.com",
9
            "question_details": [
10
                {
11
                    "question": "What are the key features of your product?",
12
                    "answer": "Our product's key features include real-time collaboration, advanced analytics, and seamless integration with other tools."
13
                },
14
                {
15
                    "question": "Is there a free trial available?",
16
                    "answer": "Yes, we offer a 14-day free trial for all new users."
17
                }
18
            ]
19
        },
20
        {
21
            "name": "Jane Smith",
22
            "email": "janesmith@example.com",
23
            "question_details": [
24
                {
25
                    "question": "How does your pricing model work?",
26
                    "answer": "We offer tiered pricing based on the number of users and features required. Please visit our website for detailed pricing information."
27
                }
28
            ]
29
        }
30
    ]
31
}

Get webinar report
Copy

Retrieves a specific webinar details report.

Sample Input

1
{
2
    "webinar_id": "123456789"
3
}

Sample Output

1
{
2
    "uuid": "abcdef12-3456-7890-abcd-ef1234567890",
3
    "id": 987654321,
4
    "host_id": "XYZ123ABC",
5
    "type": 5,
6
    "topic": "Quarterly Sales Update",
7
    "start_time": "2023-05-15T14:00:00Z",
8
    "end_time": "2023-05-15T15:30:00Z",
9
    "duration": 90,
10
    "total_minutes": 1350,
11
    "participants_count": 150,
12
    "tracking_fields": []
13
}

List activity logs report
Copy

Retrieves a list of sign in / sign out activity logs report of users under a Zoom account.

Sample Input

1
{
2
    "from": "2023-05-01T00:00:00Z",
3
    "to": "2023-05-31T23:59:59Z",
4
    "page_size": 50,
5
    "next_page_token": ""
6
}

Sample Output

1
{
2
    "from": "2023-05-01T00:00:00Z",
3
    "to": "2023-05-31T23:59:59Z",
4
    "page_size": 50,
5
    "next_page_token": "AbCdEfGhIjKlMnOpQrStUvWxYz",
6
    "activity_logs": [
7
        {
8
            "email": "user1@example.com",
9
            "time": "2023-05-15T10:30:45Z",
10
            "type": "Sign In",
11
            "ip_address": "192.168.1.100",
12
            "client_type": "Web",
13
            "version": "5.12.2"
14
        },
15
        {
16
            "email": "user2@example.com",
17
            "time": "2023-05-15T11:45:22Z",
18
            "type": "Sign Out",
19
            "ip_address": "192.168.1.101",
20
            "client_type": "Mobile",
21
            "version": "5.12.3"
22
        },
23
        {
24
            "email": "user3@example.com",
25
            "time": "2023-05-15T14:20:10Z",
26
            "type": "Sign In",
27
            "ip_address": "192.168.1.102",
28
            "client_type": "Desktop",
29
            "version": "5.12.1"
30
        }
31
    ]
32
}

List all recordings
Copy

List all cloud recordings of a user.

Sample Input

1
{
2
    "user_id": "john.doe@example.com",
3
    "from": "2023-05-01T00:00:00Z",
4
    "to": "2023-05-31T23:59:59Z",
5
    "mc": false,
6
    "trash": false,
7
    "page_size": 30,
8
    "next_page_token": ""
9
}

Sample Output

1
{
2
    "from": "2023-05-01T00:00:00Z",
3
    "to": "2023-05-31T23:59:59Z",
4
    "page_count": 1,
5
    "page_size": 30,
6
    "total_records": 2,
7
    "next_page_token": "",
8
    "meetings": [
9
        {
10
            "uuid": "abcdefgh-1234-5678-9012-ijklmnopqrst",
11
            "id": 123456789,
12
            "account_id": "ABCD1234efgh5678",
13
            "host_id": "XYZ9876wvut5432",
14
            "topic": "Team Meeting",
15
            "type": 2,
16
            "start_time": "2023-05-15T14:00:00Z",
17
            "timezone": "America/New_York",
18
            "duration": 60,
19
            "total_size": 102400000,
20
            "recording_count": 1,
21
            "share_url": "https://zoom.us/rec/share/abcdefghijklmnop",
22
            "recording_files": [
23
                {
24
                    "id": "1234abcd-5678-efgh-ijkl-9012mnopqrst",
25
                    "meeting_id": "abcdefgh-1234-5678-9012-ijklmnopqrst",
26
                    "recording_start": "2023-05-15T14:00:00Z",
27
                    "recording_end": "2023-05-15T15:00:00Z",
28
                    "file_type": "MP4",
29
                    "file_size": 102400000,
30
                    "play_url": "https://zoom.us/rec/play/abcdefghijklmnop",
31
                    "download_url": "https://zoom.us/rec/download/abcdefghijklmnop",
32
                    "status": "completed",
33
                    "recording_type": "shared_screen_with_speaker_view"
34
                }
35
            ]
36
        },
37
        {
38
            "uuid": "uvwxyz12-3456-7890-abcd-efghijklmnop",
39
            "id": 987654321,
40
            "account_id": "EFGH5678ijkl9012",
41
            "host_id": "LMN4321qrst8765",
42
            "topic": "Project Review",
43
            "type": 2,
44
            "start_time": "2023-05-20T10:00:00Z",
45
            "timezone": "Europe/London",
46
            "duration": 45,
47
            "total_size": 76800000,
48
            "recording_count": 1,
49
            "share_url": "https://zoom.us/rec/share/uvwxyz123456789",
50
            "recording_files": [
51
                {
52
                    "id": "5678efgh-9012-ijkl-mnop-3456qrstuvwx",
53
                    "meeting_id": "uvwxyz12-3456-7890-abcd-efghijklmnop",
54
                    "recording_start": "2023-05-20T10:00:00Z",
55
                    "recording_end": "2023-05-20T10:45:00Z",
56
                    "file_type": "MP4",
57
                    "file_size": 76800000,
58
                    "play_url": "https://zoom.us/rec/play/uvwxyz123456789",
59
                    "download_url": "https://zoom.us/rec/download/uvwxyz123456789",
60
                    "status": "completed",
61
                    "recording_type": "shared_screen_with_speaker_view"
62
                }
63
            ]
64
        }
65
    ]
66
}

List call logs
Copy

Retrieve a list of monthly call log metrics.

Sample Input

1
{
2
    "date_range": {
3
        "from": "2023-05-01T00:00:00Z",
4
        "to": "2023-05-31T23:59:59Z"
5
    },
6
    "site_id": "abc123xyz",
7
    "quality_type": "all",
8
    "page_size": 30,
9
    "next_page_token": ""
10
}

Sample Output

1
{
2
    "next_page_token": "NXT_PG_TKN_123456",
3
    "page_size": 30,
4
    "total_records": 150,
5
    "from": "2023-05-01T00:00:00Z",
6
    "to": "2023-05-31T23:59:59Z",
7
    "call_logs": [
8
        {
9
            "call_id": "CALL_123456",
10
            "duration": 300,
11
            "direction": "inbound",
12
            "date_time": "2023-05-15T14:30:00Z",
13
            "mos": "4.2",
14
            "caller": {
15
                "phone_number": "+14155551234"
16
            },
17
            "callee": {
18
                "extension_number": "1001"
19
            }
20
        },
21
        {
22
            "call_id": "CALL_789012",
23
            "duration": 180,
24
            "direction": "outbound",
25
            "date_time": "2023-05-16T09:45:00Z",
26
            "mos": "4.5",
27
            "caller": {
28
                "phone_number": "+14155555678"
29
            },
30
            "callee": {
31
                "extension_number": "1002"
32
            }
33
        }
34
    ]
35
}

List call recordings
Copy

Return an account's call recordings.

Sample Input

1
{
2
    "date_range": {
3
        "from": "2023-05-01T00:00:00Z",
4
        "to": "2023-05-31T23:59:59Z"
5
    },
6
    "owner_type": "user",
7
    "recording_type": "Automatic",
8
    "site_id": "abc123",
9
    "query_date_type": "start_time",
10
    "page_size": 30,
11
    "next_page_token": ""
12
}

Sample Output

1
{
2
    "next_page_token": "NXT_PG_TKN_123",
3
    "page_size": "30",
4
    "total_records": "45",
5
    "from": "2023-05-01T00:00:00Z",
6
    "to": "2023-05-31T23:59:59Z",
7
    "recordings": [
8
        {
9
            "id": "REC_123456",
10
            "caller_number": "+14155551234",
11
            "caller_number_type": "external",
12
            "caller_name": "John Doe",
13
            "callee_number": "+14155555678",
14
            "callee_number_type": "internal",
15
            "callee_name": "Jane Smith",
16
            "recording_type": "Automatic",
17
            "owner": {
18
                "type": "user",
19
                "id": "USR_789012",
20
                "extension_number": "1001",
21
                "name": "Jane Smith"
22
            },
23
            "site": {
24
                "id": "abc123",
25
                "name": "Main Office"
26
            },
27
            "direction": "inbound",
28
            "duration": 360,
29
            "download_url": "https://api.zoom.us/v2/phone/recording/download/REC_123456",
30
            "date_time": "2023-05-15T14:30:00Z"
31
        }
32
    ]
33
}

List channel members
Copy

Retrieve a list of members of a channel.

Sample Input

1
{
2
    "user_id": "abc123",
3
    "channel_id": "ch456def",
4
    "page_size": 50,
5
    "page_number": 1
6
}

Sample Output

1
{
2
    "total_records": 75,
3
    "page_size": 50,
4
    "next_page_token": "nextPageXYZ",
5
    "members": [
6
        {
7
            "id": "user789",
8
            "email": "john.doe@example.com",
9
            "first_name": "John",
10
            "last_name": "Doe",
11
            "name": "John Doe",
12
            "role": "member"
13
        },
14
        {
15
            "id": "user101",
16
            "email": "jane.smith@example.com",
17
            "first_name": "Jane",
18
            "last_name": "Smith",
19
            "name": "Jane Smith",
20
            "role": "admin"
21
        }
22
    ]
23
}

List meeting participants report
Copy

Get participant report for a past meeting.

Sample Input

1
{
2
    "meeting_id": "123456789",
3
    "page_size": 30
4
}

Sample Output

1
{
2
    "page_count": 1,
3
    "page_size": 30,
4
    "total_records": 5,
5
    "next_page_token": "",
6
    "participants": [
7
        {
8
            "id": "abcdef123456",
9
            "user_id": "user123",
10
            "name": "John Doe",
11
            "user_email": "john.doe@example.com",
12
            "join_time": "2023-05-15T14:00:00Z",
13
            "leave_time": "2023-05-15T15:30:00Z",
14
            "duration": 5400,
15
            "attentiveness_score": "85%"
16
        },
17
        {
18
            "id": "ghijkl789012",
19
            "user_id": "user456",
20
            "name": "Jane Smith",
21
            "user_email": "jane.smith@example.com",
22
            "join_time": "2023-05-15T14:05:00Z",
23
            "leave_time": "2023-05-15T15:25:00Z",
24
            "duration": 4800,
25
            "attentiveness_score": "92%"
26
        },
27
        {
28
            "id": "mnopqr345678",
29
            "user_id": "user789",
30
            "name": "Bob Johnson",
31
            "user_email": "bob.johnson@example.com",
32
            "join_time": "2023-05-15T14:10:00Z",
33
            "leave_time": "2023-05-15T15:30:00Z",
34
            "duration": 4800,
35
            "attentiveness_score": "78%"
36
        },
37
        {
38
            "id": "stuvwx901234",
39
            "user_id": "user012",
40
            "name": "Alice Brown",
41
            "user_email": "alice.brown@example.com",
42
            "join_time": "2023-05-15T14:15:00Z",
43
            "leave_time": "2023-05-15T15:20:00Z",
44
            "duration": 3900,
45
            "attentiveness_score": "88%"
46
        },
47
        {
48
            "id": "yzabcd567890",
49
            "user_id": "user345",
50
            "name": "Charlie Wilson",
51
            "user_email": "charlie.wilson@example.com",
52
            "join_time": "2023-05-15T14:20:00Z",
53
            "leave_time": "2023-05-15T15:30:00Z",
54
            "duration": 4200,
55
            "attentiveness_score": "95%"
56
        }
57
    ]
58
}

List meeting registrants
Copy

Retrieves a list of registrants for a specific meeting.

Sample Input

1
{
2
    "user_id": "john.doe@example.com",
3
    "meeting_id": "123456789",
4
    "status": "approved",
5
    "page_size": 30,
6
    "page_number": 1
7
}

Sample Output

1
{
2
    "page_count": 2,
3
    "page_number": 1,
4
    "page_size": 30,
5
    "total_records": 45,
6
    "registrants": [
7
        {
8
            "id": "abcdef123456",
9
            "first_name": "Alice",
10
            "last_name": "Smith",
11
            "email": "alice.smith@example.com",
12
            "address": "123 Main St",
13
            "city": "New York",
14
            "country": "US",
15
            "zip": "10001",
16
            "state": "NY",
17
            "phone": "+1234567890",
18
            "industry": "Technology",
19
            "org": "Tech Corp",
20
            "job_title": "Software Engineer",
21
            "purchasing_time_frame": "Within 3 months",
22
            "role_in_purchase_process": "Decision Maker",
23
            "no_of_employees": "100-500",
24
            "comments": "Looking forward to the meeting!",
25
            "custom_questions": [],
26
            "status": "approved",
27
            "create_time": "2023-05-15T10:30:00Z",
28
            "join_url": "https://zoom.us/j/123456789?pwd=abcdefghijklmnop"
29
        }
30
    ]
31
}

List meetings
Copy

List all the meetings that were scheduled for a user (meeting host).

Sample Input

1
{
2
    "user_id": "john.doe@example.com",
3
    "meeting_type": "upcoming",
4
    "date_range": {
5
        "from": "2023-05-01T00:00:00Z",
6
        "to": "2023-05-31T23:59:59Z"
7
    },
8
    "page_size": 30,
9
    "page_number": 1
10
}

Sample Output

1
{
2
    "page_count": 2,
3
    "page_number": 1,
4
    "page_size": 30,
5
    "total_records": 45,
6
    "meetings": [
7
        {
8
            "uuid": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
9
            "id": 123456789,
10
            "host_id": "XYZ987654",
11
            "topic": "Weekly Team Meeting",
12
            "type": 2,
13
            "start_time": "2023-05-15T14:00:00Z",
14
            "duration": 60,
15
            "timezone": "America/New_York",
16
            "created_at": "2023-05-01T10:30:00Z",
17
            "join_url": "https://zoom.us/j/123456789"
18
        },
19
        {
20
            "uuid": "zyxwvuts-rqpo-nmlk-jihg-fedcba654321",
21
            "id": 987654321,
22
            "host_id": "XYZ987654",
23
            "topic": "Project Review",
24
            "type": 2,
25
            "start_time": "2023-05-20T10:00:00Z",
26
            "duration": 90,
27
            "timezone": "America/New_York",
28
            "created_at": "2023-05-02T15:45:00Z",
29
            "join_url": "https://zoom.us/j/987654321"
30
        }
31
    ]
32
}

List meetings report
Copy

Retrieves a list of past meetings for a specified period of time, for a given user.

Sample Input

1
{
2
    "user_id": "john.doe@example.com",
3
    "from": "2023-05-01T00:00:00Z",
4
    "to": "2023-05-31T23:59:59Z",
5
    "page_size": 30
6
}

Sample Output

1
{
2
    "from": "2023-05-01T00:00:00Z",
3
    "to": "2023-05-31T23:59:59Z",
4
    "page_count": 2,
5
    "page_size": 30,
6
    "total_records": 45,
7
    "next_page_token": "abcdefghijklmnop",
8
    "meetings": [
9
        {
10
            "uuid": "1234abcd-5678-efgh-ijkl-mnopqrstuvwx",
11
            "id": 987654321,
12
            "host_id": "host123",
13
            "type": 2,
14
            "topic": "Team Weekly Standup",
15
            "user_name": "John Doe",
16
            "user_email": "john.doe@example.com",
17
            "start_time": "2023-05-03T09:00:00Z",
18
            "end_time": "2023-05-03T10:00:00Z",
19
            "duration": 60,
20
            "total_minutes": 60,
21
            "participants_count": 8
22
        },
23
        {
24
            "uuid": "2345bcde-6789-fghi-jklm-nopqrstuvwxy",
25
            "id": 987654322,
26
            "host_id": "host123",
27
            "type": 2,
28
            "topic": "Project Review Meeting",
29
            "user_name": "John Doe",
30
            "user_email": "john.doe@example.com",
31
            "start_time": "2023-05-10T14:00:00Z",
32
            "end_time": "2023-05-10T15:30:00Z",
33
            "duration": 90,
34
            "total_minutes": 90,
35
            "participants_count": 5
36
        }
37
    ]
38
}

List operation logs report
Copy

Retrieves operation logs report for a specified period of time.

Sample Input

1
{
2
    "from": "2023-05-01T00:00:00Z",
3
    "to": "2023-05-31T23:59:59Z",
4
    "page_size": 50,
5
    "next_page_token": "abcdefghijklmnopqrstuvwxyz123456"
6
}

Sample Output

1
{
2
    "from": "2023-05-01T00:00:00Z",
3
    "to": "2023-05-31T23:59:59Z",
4
    "page_size": 50,
5
    "next_page_token": "789abcdefghijklmnopqrstuvwxyz0123",
6
    "operation_logs": [
7
        {
8
            "time": "2023-05-15T14:30:22Z",
9
            "operator": "john.doe@example.com",
10
            "category_type": "User",
11
            "action": "Create",
12
            "operation_detail": "Created new user account for jane.smith@example.com"
13
        },
14
        {
15
            "time": "2023-05-16T09:45:10Z",
16
            "operator": "admin@example.com",
17
            "category_type": "Meeting",
18
            "action": "Update",
19
            "operation_detail": "Updated recurring meeting settings for Weekly Team Sync"
20
        },
21
        {
22
            "time": "2023-05-17T11:20:05Z",
23
            "operator": "system",
24
            "category_type": "Security",
25
            "action": "Block",
26
            "operation_detail": "Blocked suspicious IP address 203.0.113.42"
27
        }
28
    ]
29
}

List phone users
Copy

Return all of an account's users who are assigned to a Zoom phone license.

Sample Input

1
{
2
    "site_id": "abc123",
3
    "page_size": 5,
4
    "next_page_token": "def456"
5
}

Sample Output

1
{
2
    "next_page_token": "ghi789",
3
    "page_size": 5,
4
    "total_records": 15,
5
    "users": [
6
        {
7
            "calling_plans": [
8
                {
9
                    "name": "Pro",
10
                    "type": 1
11
                }
12
            ],
13
            "id": "user123",
14
            "phone_user_id": "phone456",
15
            "email": "john.doe@example.com",
16
            "name": "John Doe",
17
            "extension_number": 1001,
18
            "status": "active",
19
            "site": {
20
                "id": "site789",
21
                "name": "Main Office"
22
            }
23
        },
24
        {
25
            "calling_plans": [
26
                {
27
                    "name": "Business",
28
                    "type": 2
29
                }
30
            ],
31
            "id": "user234",
32
            "phone_user_id": "phone567",
33
            "email": "jane.smith@example.com",
34
            "name": "Jane Smith",
35
            "extension_number": 1002,
36
            "status": "active",
37
            "site": {
38
                "id": "site789",
39
                "name": "Main Office"
40
            }
41
        }
42
    ]
43
}

List role members
Copy

Return all members that are assigned to a specific role.

Sample Input

1
{
2
    "role_id": "ABCD1234",
3
    "page_count": "1",
4
    "page_size": 30,
5
    "next_page_token": "qwertyuiop1234567890"
6
}

Sample Output

1
{
2
    "page_count": 1,
3
    "page_number": 1,
4
    "page_size": 30,
5
    "total_records": 2,
6
    "members": [
7
        {
8
            "id": "user123",
9
            "email": "john.doe@example.com",
10
            "first_name": "John",
11
            "last_name": "Doe",
12
            "type": 1,
13
            "department": "Sales"
14
        },
15
        {
16
            "id": "user456",
17
            "email": "jane.smith@example.com",
18
            "first_name": "Jane",
19
            "last_name": "Smith",
20
            "type": 2,
21
            "department": "Marketing"
22
        }
23
    ]
24
}

List roles
Copy

Return all roles listed on your account.

Sample Input

1
{}

Sample Output

1
{
2
    "total_records": 3,
3
    "roles": [
4
        {
5
            "id": "1234567890",
6
            "name": "Admin",
7
            "description": "Full administrative access to all Zoom features",
8
            "total_members": 5
9
        },
10
        {
11
            "id": "2345678901",
12
            "name": "Manager",
13
            "description": "Manage users and rooms, but cannot change account settings",
14
            "total_members": 10
15
        },
16
        {
17
            "id": "3456789012",
18
            "name": "Member",
19
            "description": "Basic access to join meetings and use chat",
20
            "total_members": 50
21
        }
22
    ]
23
}

List telephone report
Copy

Gets telephone report for a specified period of time.

Sample Input

1
{
2
    "from": "2023-05-01T00:00:00Z",
3
    "to": "2023-05-31T23:59:59Z",
4
    "page_size": 50,
5
    "next_page_token": "abcdefghijklmnop"
6
}

Sample Output

1
{
2
    "from": "2023-05-01T00:00:00Z",
3
    "to": "2023-05-31T23:59:59Z",
4
    "page_count": 3,
5
    "page_number": 1,
6
    "page_size": 50,
7
    "total_records": 125,
8
    "telephony_usage": [
9
        {
10
            "meeting_id": "123456789",
11
            "phone_number": "+14155551234",
12
            "host_name": "John Doe",
13
            "host_email": "john.doe@example.com",
14
            "dept": "Sales",
15
            "start_time": "2023-05-15T10:00:00Z",
16
            "end_time": "2023-05-15T11:30:00Z",
17
            "duration": 90,
18
            "total": 1.5,
19
            "country_name": "United States",
20
            "meeting_type": "Scheduled Meeting",
21
            "call_in_number": "+18885551234"
22
        },
23
        {
24
            "meeting_id": "987654321",
25
            "phone_number": "+442071234567",
26
            "host_name": "Jane Smith",
27
            "host_email": "jane.smith@example.com",
28
            "dept": "Marketing",
29
            "start_time": "2023-05-20T14:00:00Z",
30
            "end_time": "2023-05-20T15:15:00Z",
31
            "duration": 75,
32
            "total": 1.25,
33
            "country_name": "United Kingdom",
34
            "meeting_type": "Instant Meeting",
35
            "call_in_number": "+442033333333"
36
        }
37
    ]
38
}

List user channels
Copy

Retrieve a list of channels related to a user.

Sample Input

1
{
2
    "user_id": "abc123xyz456",
3
    "page_size": 50,
4
    "page_number": 1
5
}

Sample Output

1
{
2
    "total_records": 75,
3
    "page_size": 50,
4
    "next_page_token": "NiIsImN1cnNvciI6IkFBQUFBR",
5
    "channels": [
6
        {
7
            "id": "ch1234567890",
8
            "jid": "ch1234567890@conference.zoomchat.us",
9
            "name": "Marketing Team",
10
            "type": 1,
11
            "channel_settings": {
12
                "new_members_can_see_previous_messages_files": true,
13
                "allow_to_add_external_users": 1,
14
                "posting_permissions": 2
15
            }
16
        },
17
        {
18
            "id": "ch0987654321",
19
            "jid": "ch0987654321@conference.zoomchat.us",
20
            "name": "Project Alpha",
21
            "type": 2,
22
            "channel_settings": {
23
                "new_members_can_see_previous_messages_files": false,
24
                "allow_to_add_external_users": 0,
25
                "posting_permissions": 1
26
            }
27
        }
28
    ]
29
}

List user chat messages
Copy

Retrieve a list of a user's chat messages.

Sample Input

1
{
2
    "user_id": "abc123",
3
    "to_channel": "channel456",
4
    "page_size": 50,
5
    "page_number": 1
6
}

Sample Output

1
{
2
    "date": "2023-05-15",
3
    "page_size": 50,
4
    "next_page_token": "nextPageXYZ",
5
    "messages": [
6
        {
7
            "id": "msg1",
8
            "message": "Hello team, how's the project coming along?",
9
            "sender": "john@example.com",
10
            "date_time": "2023-05-15T09:30:00Z",
11
            "timestamp": 1684142400
12
        },
13
        {
14
            "id": "msg2",
15
            "message": "We're making good progress. The first milestone is almost complete.",
16
            "sender": "sarah@example.com",
17
            "date_time": "2023-05-15T09:35:00Z",
18
            "timestamp": 1684142700
19
        },
20
        {
21
            "id": "msg3",
22
            "message": "Great to hear! Let's schedule a review meeting for tomorrow.",
23
            "sender": "john@example.com",
24
            "date_time": "2023-05-15T09:40:00Z",
25
            "timestamp": 1684143000
26
        }
27
    ]
28
}

List users
Copy

List users on your account.

Sample Input

1
{
2
    "status": "active",
3
    "role_id": "2",
4
    "page_size": 30,
5
    "page_number": 1
6
}

Sample Output

1
{
2
    "page_count": 2,
3
    "page_number": 1,
4
    "page_size": 30,
5
    "total_records": 45,
6
    "users": [
7
        {
8
            "id": "abc123",
9
            "first_name": "John",
10
            "last_name": "Doe",
11
            "email": "john.doe@example.com",
12
            "type": 2,
13
            "pmi": 1234567890,
14
            "timezone": "America/New_York",
15
            "verified": 1,
16
            "dept": "Sales",
17
            "created_at": "2023-01-15T10:30:00Z",
18
            "last_login_time": "2023-05-20T14:45:00Z",
19
            "last_client_version": "5.13.5",
20
            "status": "active"
21
        },
22
        {
23
            "id": "def456",
24
            "first_name": "Jane",
25
            "last_name": "Smith",
26
            "email": "jane.smith@example.com",
27
            "type": 2,
28
            "pmi": 9876543210,
29
            "timezone": "Europe/London",
30
            "verified": 1,
31
            "dept": "Marketing",
32
            "created_at": "2023-02-01T09:15:00Z",
33
            "last_login_time": "2023-05-19T16:30:00Z",
34
            "last_client_version": "5.13.5",
35
            "status": "active"
36
        }
37
    ]
38
}

List webinar participants report
Copy

Get detailed report on each attendee of a webinar.

Sample Input

1
{
2
    "webinar_id": "123456789",
3
    "page_size": 50,
4
    "page_number": 1
5
}

Sample Output

1
{
2
    "page_count": 2,
3
    "page_size": 50,
4
    "total_records": 75,
5
    "next_page_token": "abcdefghijklmnop",
6
    "participants": [
7
        {
8
            "id": "participant1",
9
            "user_id": "user123",
10
            "name": "John Doe",
11
            "user_email": "john.doe@example.com",
12
            "join_time": "2023-05-15T14:00:00Z",
13
            "leave_time": "2023-05-15T15:30:00Z",
14
            "duration": 90,
15
            "attentiveness_score": "85%"
16
        },
17
        {
18
            "id": "participant2",
19
            "user_id": "user456",
20
            "name": "Jane Smith",
21
            "user_email": "jane.smith@example.com",
22
            "join_time": "2023-05-15T14:05:00Z",
23
            "leave_time": "2023-05-15T15:25:00Z",
24
            "duration": 80,
25
            "attentiveness_score": "92%"
26
        }
27
    ]
28
}

List webinar registrants
Copy

Retrieves a list of registrants for a specific webinar.

Sample Input

1
{
2
    "user_id": "john.doe@example.com",
3
    "webinar_id": "123456789",
4
    "page_size": 30,
5
    "page_number": 1,
6
    "status": "approved",
7
    "occurrence_id": "1234567890"
8
}

Sample Output

1
{
2
    "page_count": "2",
3
    "page_number": "1",
4
    "page_size": "30",
5
    "total_records": "45",
6
    "registrants": [
7
        {
8
            "id": "abcdef123456",
9
            "email": "attendee1@example.com",
10
            "first_name": "Alice",
11
            "last_name": "Smith",
12
            "address": "123 Main St",
13
            "city": "New York",
14
            "country": "US",
15
            "zip": "10001",
16
            "state": "NY",
17
            "phone": "+1234567890",
18
            "industry": "Technology",
19
            "org": "Tech Corp",
20
            "job_title": "Software Engineer",
21
            "purchasing_time_frame": "Within 3 months",
22
            "role_in_purchase_process": "Decision Maker",
23
            "no_of_employees": "100-500",
24
            "comments": "Looking forward to the webinar!",
25
            "custom_questions": [
26
                {
27
                    "title": "What topics are you most interested in?",
28
                    "value": "AI and Machine Learning"
29
                }
30
            ],
31
            "status": "approved",
32
            "create_time": "2023-05-15T10:30:00Z",
33
            "join_url": "https://zoom.us/w/123456789/join"
34
        },
35
        {
36
            "id": "ghijkl789012",
37
            "email": "attendee2@example.com",
38
            "first_name": "Bob",
39
            "last_name": "Johnson",
40
            "address": "456 Elm St",
41
            "city": "San Francisco",
42
            "country": "US",
43
            "zip": "94105",
44
            "state": "CA",
45
            "phone": "+1987654321",
46
            "industry": "Finance",
47
            "org": "Finance Inc",
48
            "job_title": "Financial Analyst",
49
            "purchasing_time_frame": "Within 6 months",
50
            "role_in_purchase_process": "Influencer",
51
            "no_of_employees": "500-1000",
52
            "comments": "Excited to learn about new financial technologies",
53
            "custom_questions": [
54
                {
55
                    "title": "What is your primary goal for attending?",
56
                    "value": "Networking and learning about industry trends"
57
                }
58
            ],
59
            "status": "approved",
60
            "create_time": "2023-05-16T14:45:00Z",
61
            "join_url": "https://zoom.us/w/123456789/join"
62
        }
63
    ]
64
}

List webinars
Copy

List all the webinars that are scheduled by or on-behalf a user (Webinar host).

Sample Input

1
{
2
    "user_id": "john.doe@example.com",
3
    "page_size": 30,
4
    "page_number": 1
5
}

Sample Output

1
{
2
    "page_count": 2,
3
    "page_number": 1,
4
    "page_size": 30,
5
    "total_records": 45,
6
    "webinars": [
7
        {
8
            "uuid": "abcdef123456",
9
            "id": 987654321,
10
            "host_id": "host123",
11
            "topic": "Introduction to Zoom Webinars",
12
            "type": 5,
13
            "start_time": "2023-06-15T14:00:00Z",
14
            "duration": 60,
15
            "timezone": "America/New_York",
16
            "agenda": "Learn the basics of hosting Zoom webinars",
17
            "created_at": "2023-05-01T10:30:00Z",
18
            "join_url": "https://zoom.us/w/987654321"
19
        },
20
        {
21
            "uuid": "ghijkl789012",
22
            "id": 123456789,
23
            "host_id": "host123",
24
            "topic": "Advanced Zoom Features",
25
            "type": 5,
26
            "start_time": "2023-06-22T15:00:00Z",
27
            "duration": 90,
28
            "timezone": "America/New_York",
29
            "agenda": "Explore advanced features of Zoom webinars",
30
            "created_at": "2023-05-05T11:45:00Z",
31
            "join_url": "https://zoom.us/w/123456789"
32
        }
33
    ]
34
}

Raw HTTP request (advanced)
Copy

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Sample Input

1
{
2
    "method": "GET",
3
    "url": {
4
        "endpoint": "/users/me"
5
    },
6
    "headers": [
7
        {
8
            "key": "Accept",
9
            "value": "application/json"
10
        }
11
    ],
12
    "query_parameters": [
13
        {
14
            "key": "include_fields",
15
            "value": "first_name,last_name,email"
16
        }
17
    ],
18
    "body": {
19
        "none": null
20
    },
21
    "include_raw_body": false,
22
    "parse_response": "true"
23
}

Sample Output

1
{
2
    "response": {
3
        "status_code": 200,
4
        "headers": {
5
            "Content-Type": "application/json",
6
            "Date": "Wed, 15 Mar 2023 10:30:45 GMT",
7
            "Server": "ZoomAPI"
8
        },
9
        "body": {
10
            "id": "abc123",
11
            "first_name": "John",
12
            "last_name": "Doe",
13
            "email": "john.doe@example.com"
14
        }
15
    }
16
}

Search company contacts
Copy

Search for a contact using the 'Search key' field by providing the user's first name, last name or email address.

Sample Input

1
{
2
    "search_key": "john.doe@example.com",
3
    "query_presence_status": true,
4
    "page_size": 2,
5
    "next_page_token": ""
6
}

Sample Output

1
{
2
    "page_size": 2,
3
    "next_page_token": "abcdefghijklmnop",
4
    "contacts": [
5
        {
6
            "id": "abc123",
7
            "email": "john.doe@example.com",
8
            "first_name": "John",
9
            "last_name": "Doe",
10
            "presence_status": "Available",
11
            "job_title": "Software Engineer",
12
            "location": "New York, NY"
13
        },
14
        {
15
            "id": "def456",
16
            "email": "john.smith@example.com",
17
            "first_name": "John",
18
            "last_name": "Smith",
19
            "presence_status": "In a meeting",
20
            "job_title": "Product Manager",
21
            "location": "San Francisco, CA"
22
        }
23
    ]
24
}

Update meeting registrants status
Copy

Retrieves a list of registrants for a specific meeting.

Sample Input

1
{
2
    "user_id": "john.doe@example.com",
3
    "meeting_id": "123456789",
4
    "action": "approve",
5
    "registrants": [
6
        {
7
            "id": "reg123",
8
            "email": "attendee1@example.com"
9
        },
10
        {
11
            "id": "reg456",
12
            "email": "attendee2@example.com"
13
        }
14
    ]
15
}

Sample Output

1
{
2
    "updated": true
3
}

Update user status
Copy

Deactivate an active user or reactivate a deactivated user.

Sample Input

1
{
2
    "user_id": "john.doe@example.com",
3
    "action": "deactivate"
4
}

Sample Output

1
{
2
    "updated": true
3
}

Update webinar registrant status
Copy

Update a webinar registrant’s status.

Sample Input

1
{
2
    "webinar_id": "123456789",
3
    "action": "approve",
4
    "registrants": [
5
        {
6
            "email": "john.doe@example.com"
7
        },
8
        {
9
            "email": "jane.smith@example.com"
10
        }
11
    ]
12
}

Sample Output

1
{
2
    "updated": true
3
}

DDL operations
Copy

List authentication options (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "options": [
3
        {
4
            "id": "default",
5
            "name": "Default",
6
            "type": "default"
7
        },
8
        {
9
            "id": "google",
10
            "name": "Google",
11
            "type": "oauth"
12
        },
13
        {
14
            "id": "facebook",
15
            "name": "Facebook",
16
            "type": "oauth"
17
        },
18
        {
19
            "id": "microsoft",
20
            "name": "Microsoft",
21
            "type": "oauth"
22
        },
23
        {
24
            "id": "sso",
25
            "name": "Single Sign-On (SSO)",
26
            "type": "sso"
27
        }
28
    ]
29
}

List meetings (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "meetings": [
3
        {
4
            "id": 123456789,
5
            "topic": "Weekly Team Meeting",
6
            "start_time": "2023-05-15T14:00:00Z",
7
            "duration": 60,
8
            "timezone": "America/New_York",
9
            "join_url": "https://zoom.us/j/123456789",
10
            "host_id": "abc123def456",
11
            "status": "waiting"
12
        },
13
        {
14
            "id": 987654321,
15
            "topic": "Client Presentation",
16
            "start_time": "2023-05-16T10:30:00Z",
17
            "duration": 45,
18
            "timezone": "Europe/London",
19
            "join_url": "https://zoom.us/j/987654321",
20
            "host_id": "xyz789uvw456",
21
            "status": "started"
22
        }
23
    ]
24
}

List phone users (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "id": "user123",
4
        "email": "john.doe@example.com",
5
        "first_name": "John",
6
        "last_name": "Doe",
7
        "phone_number": "+1234567890",
8
        "extension_number": "1001",
9
        "status": "active",
10
        "site": {
11
            "id": "site456",
12
            "name": "Main Office"
13
        },
14
        "department": "Sales",
15
        "cost_center": "CC001",
16
        "calling_plans": [
17
            {
18
                "type": "Zoom Phone Pro",
19
                "name": "United States and Canada Unlimited"
20
            }
21
        ]
22
    },
23
    {
24
        "id": "user456",
25
        "email": "jane.smith@example.com",
26
        "first_name": "Jane",
27
        "last_name": "Smith",
28
        "phone_number": "+1987654321",
29
        "extension_number": "1002",
30
        "status": "active",
31
        "site": {
32
            "id": "site789",
33
            "name": "Branch Office"
34
        },
35
        "department": "Marketing",
36
        "cost_center": "CC002",
37
        "calling_plans": [
38
            {
39
                "type": "Zoom Phone Pro",
40
                "name": "Global Select"
41
            }
42
        ]
43
    }
44
]

List roles (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "roles": [
3
        {
4
            "id": "y3KSZRx7QpmkVhOKkWdHYg",
5
            "name": "Owner",
6
            "description": "This role grants the user full administrative access.",
7
            "total_members": 2
8
        },
9
        {
10
            "id": "Z9KSZRx7QpmkVhOKkWdHYg",
11
            "name": "Admin",
12
            "description": "This role allows the user to manage most aspects of the account.",
13
            "total_members": 5
14
        },
15
        {
16
            "id": "A7KSZRx7QpmkVhOKkWdHYg",
17
            "name": "Member",
18
            "description": "This role allows the user to join meetings and manage their own settings.",
19
            "total_members": 50
20
        }
21
    ],
22
    "total_records": 3,
23
    "page_size": 30,
24
    "next_page_token": ""
25
}

List user channels (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "channels": [
3
        {
4
            "id": "abcdef123456",
5
            "name": "General",
6
            "type": 1
7
        },
8
        {
9
            "id": "ghijkl789012",
10
            "name": "Marketing",
11
            "type": 2
12
        },
13
        {
14
            "id": "mnopqr345678",
15
            "name": "Engineering",
16
            "type": 2
17
        }
18
    ]
19
}

List users (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "users": [
3
        {
4
            "id": "abc123",
5
            "first_name": "John",
6
            "last_name": "Doe",
7
            "email": "john.doe@example.com",
8
            "type": 2,
9
            "pmi": 1234567890,
10
            "timezone": "America/New_York",
11
            "verified": 1,
12
            "created_at": "2023-05-15T10:30:00Z",
13
            "last_login_time": "2023-05-20T14:45:00Z",
14
            "language": "en-US",
15
            "status": "active",
16
            "role_name": "Member"
17
        },
18
        {
19
            "id": "def456",
20
            "first_name": "Jane",
21
            "last_name": "Smith",
22
            "email": "jane.smith@example.com",
23
            "type": 1,
24
            "pmi": 9876543210,
25
            "timezone": "Europe/London",
26
            "verified": 1,
27
            "created_at": "2023-04-01T09:00:00Z",
28
            "last_login_time": "2023-05-19T16:30:00Z",
29
            "language": "en-GB",
30
            "status": "active",
31
            "role_name": "Admin"
32
        }
33
    ]
34
}

List webinars (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "data": [
3
        {
4
            "id": "123456789",
5
            "topic": "Introduction to Zoom Webinars",
6
            "start_time": "2023-06-15T14:00:00Z",
7
            "duration": 60,
8
            "timezone": "America/New_York",
9
            "agenda": "Learn the basics of hosting Zoom webinars",
10
            "host_id": "abc123def456",
11
            "type": 5
12
        },
13
        {
14
            "id": "987654321",
15
            "topic": "Advanced Zoom Features",
16
            "start_time": "2023-06-20T10:00:00Z",
17
            "duration": 90,
18
            "timezone": "Europe/London",
19
            "agenda": "Explore advanced features of Zoom webinars",
20
            "host_id": "xyz789uvw321",
21
            "type": 5
22
        }
23
    ],
24
    "page_count": 1,
25
    "page_number": 1,
26
    "page_size": 30,
27
    "total_records": 2
28
}
Previous

Overview

Next

Operations