REST Group API Follow

Update: Please see our Developer Portal for more up to date content on our REST API and Mobile SDK.

The following API calls go over the creation, management, and deleting of Groups through Zooms REST API calls.

List all groups on your Zoom account.

Endpoint:

https://api.zoom.us/v1/group/list

Parameters:

None

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret' https://api.zoom.us/v1/group/list

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <total_records>3</total_records>
    <groups>
        <group>
            <group_id>vm8jdDSdSEm8epNh0K6uTw</group_id>
            <account_id>4CnTi6oHToe1xpWn7lfU9A</account_id>
            <name>Group Test1</name>
            <total_members>40</total_members>
        </group>
        <group>
            <group_id>R2DbDoFMQHWoqF0mJ3ozEw</group_id>
            <account_id>4CnTi6oHToe1xpWn7lfU9A</account_id>
            <name>Group Test2</name>
            <total_members>2</total_members>
        </group>
        <group>
            <group_id>n7U0azDYRxO-q12rhaLKhA</group_id>
            <account_id>4CnTi6oHToe1xpWn7lfU9A</account_id>
            <name> Group Test3</name>
            <total_members>0</total_members>
        </group>
    </groups>
</result>

Response JSON:

{
    "total_records": 3,
    "groups": [{
        "group_id": "vm8jdDSdSEm8epNh0K6uTw",
        "account_id": "4CnTi6oHToe1xpWn7lfU9A",
        "name": "Group Test1",
        "total_members": 40
    }, {
        "group_id": "R2DbDoFMQHWoqF0mJ3ozEw",
        "account_id": "4CnTi6oHToe1xpWn7lfU9A",
        "name": "Group Test2",
        "total_members": 2
    }, {
        "group_id": "n7U0azDYRxO-q12rhaLKhA",
        "account_id": "4CnTi6oHToe1xpWn7lfU9A",
        "name": "Group Test3",
        "total_members": 0
    }]
}

Get a group on Zoom via id, return the group info

Endpoint:

https://api.zoom.us/v1/group/get

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=group_id' https://api.zoom.us/v1/group/get

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<group>
    <group_id>R2DbDoFMQHWoqF0mJ3ozEw</group_id>
    <account_id>4CnTi6oHToe1xpWn7lfU9A</account_id>
    <name>Group Test2</name>
    <total_members>2</total_members>
</group>

Response JSON:

{
    "group_id": "R2DbDoFMQHWoqF0mJ3ozEw",
    "account_id": "4CnTi6oHToe1xpWn7lfU9A",
    "name": "Group Test2",
    "total_members": 2
}

Create a group on Zoom, return the new group info.

Endpoint:

https://api.zoom.us/v1/group/create

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&name=group_name' https://api.zoom.us/v1/group/create

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<group>
    <group_id>iEAohxv8RoaozPT310dW7g</group_id>
    <account_id>4CnTi6oHToe1xpWn7lfU9A</account_id>
    <name>New Group Test2</name>
    <total_members>0</total_members>
</group>

Response JSON:

{
    "group_id": "W8r1m-FSQiiTJsAICWvnzA",
    "account_id": "4CnTi6oHToe1xpWn7lfU9A",
    "name": "New Group Test",
    "total_members": 0
}

Edit a group on Zoom, return the new group info.

Endpoint:

https://api.zoom.us/v1/group/edit

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=group_id' https://api.zoom.us/v1/group/edit

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<group>
    <group_id>iEAohxv8RoaozPT310dW7g</group_id>
    <account_id>4CnTi6oHToe1xpWn7lfU9A</account_id>
    <name>New Group Test2</name>
    <total_members>0</total_members>
</group>

Response JSON:

{
    "group_id": "W8r1m-FSQiiTJsAICWvnzA",
    "account_id": "4CnTi6oHToe1xpWn7lfU9A",
    "name": "New Group Test",
    "total_members": 0
}

Delete a group on Zoom, return the deleted group id.

Endpoint:

https://api.zoom.us/v1/group/delete

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=group_id' https://api.zoom.us/v1/group/delete

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <id>iEAohxv8RoaozPT310dW7g</id>
    <deleted_at>2015-08-20T08:41:37Z</deleted_at>
    <deleted_count>1</deleted_count>
</result> 

Response JSON:

{
    "id": "R2DbDoFMQHWoqF0mJ3ozEw",
    "deleted_at": "2015-08-20T08:41:58Z",
    "deleted_count": 1
}

Lists the members of a group on Zoom.

Endpoint:

https://api.zoom.us/v1/group/member/list

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=group_id' https://api.zoom.us/v1/group/member/list

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <page_count>1</page_count>
    <page_number>1</page_number>
    <page_size>30</page_size>
    <total_records>1</total_records>
    <members>
        <memeber>
            <id>6EoubcvJR7eF2grNXJkrHA</id>
            <email>test.us@zoom.us </email>
            <first_name>Test</first_name>
            <last_name>Us</last_name>
         <pic_url>https://ssotest.zoom.us/p/6EoubcvJR7eF2grNXJkrHA/f2003a9c-3095-4865-8536-03cc6f211e86-9569</pic_url>
        </memeber>
    </members>
</result>

Response JSON:

{
    "page_count": 1,
    "page_number": 1,
    "page_size": 30,
    "total_records": 1,
    "members": [{
        "id": "6EoubcvJR7eF2grNXJkrHA",
        "email": "test.us@zoom.us",
        "first_name": "Text",
        "last_name": "Us",
        "pic_url": "https://ssotest.zoom.us/p/6EoubcvJR7eF2grNXJkrHA/f2003a9c-3095-4865-8536-03cc6f211e86-9569"
    }]
}

Adds members to a group on Zoom.

Endpoint:

https://api.zoom.us/v1/group/member/add

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=group_id&member_ids=user_ids' https://api.zoom.us/v1/group/member/add

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <id>W8r1m-FSQiiTJsAICWvnzA</id>
    <add_at>2015-08-20T08:54:49Z</add_at>
    <add_count>1</add_count>
</result> 

Response JSON:

{
    "id": "W8r1m-FSQiiTJsAICWvnzA",
    "add_at": "2015-08-20T08:55:03Z",
    "add_count": 1
}

Delete members of a group on Zoom.

Endpoint:

https://api.zoom.us/v1/group/member/delete

Parameters:

cURL Example:

curl --data 'api_key=your_api_key&api_secret=your_api_secret&id=group_id&member_ids=user_ids' https://api.zoom.us/v1/member/delete

Response XML:

<?xml version="1.0" encoding="UTF-8" ?>
<result>
    <id>W8r1m-FSQiiTJsAICWvnzA</id>
    <deleted_at>2015-08-20T08:57:50Z</deleted_at>
    <deleted_count>2</deleted_count>
</result>

Response JSON:

{
    "id": "W8r1m-FSQiiTJsAICWvnzA",
    "deleted_at": "2015-08-20T08:57:38Z",
    "deleted_count": 2
}
Was this article helpful?
Have more questions? Submit a request
Powered by Zendesk