Get started with GraphQL

Beta

Zoom GraphQL is in a public beta.

• See the GraphQL beta FAQ for details.
• Get started using the Zoom GraphQL API playground.
• See the Zoom GraphQL API playground blog post for details.

GraphQL endpoint

Zoom GraphQL is available at the following endpoint: https://api.zoom.us/v3/graphql

Make your first GraphQL query

Follow these steps to make your first GraphQL query in Postman, to get the uuid, id, and joinUrl for your previous meetings.

Before you start

1. Log on to your Marketplace account (be sure to use an account that you've used for some meetings in the past).
2. Create a Server-to-Server OAuth app type.
3. Add the scope to View all user meetings: meeting:read:admin

Create an authorization token

4. In the Postman Params tab, add the following keys and values:

   Key	Value
   grant_type	account_credentials
   account_id	Your Account ID, shown in the App credentials tab for your app in Marketplace (use a Postman variable for this and other credentials).

5. In the Postman Authorization tab, enter your app's Client ID as the Username and Client secret as the Password.

6. Choose POST, enter request URL https://zoom.us/oauth/token and click Send.

7. Copy your access token.

Query meetings

8. Create a new request and click the Postman Authorization tab.

9. In Type, choose Bearer Token.

10. Enter your access token (use a variable).

11. Click Body, choose GraphQL, and enter the following test query:

    {
        meetings(meetingType: PREVIOUS_MEETINGS) {
            edges {
                uuid
                id
                joinUrl
            }
        }
    }
    

12. Choose POST, enter request URL https://zoom.us/v3/graphql and click Send.

13. If you've had previous meetings on this account, you should get a response like the following:

    {
        "data": {
            "meetings": {
                "edges": [
                    {
                        "uuid": "AAABBBCCCDDDEEEFFFGGGH==",
                        "id": 11111111111,
                        "joinUrl": "https://link.example.com/a/11111111111"
                    },
                    {
                        "uuid": "1112223334445556667778==",
                        "id": 22222222222,
                        "joinUrl": "https://link.example.com/a/22222222222?pwd=000000000000000000000000000000.0"
                    },
                    {
                        "uuid": "+++===+++===+++===+++w+==",
                        "id": 33333333333,
                        "joinUrl": "https://link.example.com/a/33333333333"
                    }
                ]
            }
        }
    }
    

Learn more

• See Using GraphQL for more details about authentication, queries, mutations, and pagination.
• See Postman samples for information about the Zoom GraphQL public workspace on Postman and how to add the Zoom GraphQL schema to Postman.
• See Scopes and Rate limits for tables showing these affect GraphQL queries and mutations.
• Use the Zoom GraphQL API playground to send queries and mutations directly in your web browser. Access the GraphQL reference documentation and autocomplete JSON code directly in the playground. See the Zoom Dev article to learn more.