Zoom GraphQL beta FAQ

Beta

Zoom GraphQL is in a public beta.

Here are some answers to Frequently Asked Questions about the GraphQL public beta.

What is GraphQL?

GraphQL is a query language and server-side runtime for application programming interfaces (APIs) that prioritizes giving clients exactly the data they request and no more.

GraphQL is designed to make APIs fast, flexible, and developer-friendly. It can even be deployed within an integrated development environment (IDE) known as GraphiQL.

What is the difference between GraphQL and REST API?

GraphQL lets developers construct requests that pull data from multiple data sources in a single API call.

REST API

REST stands for Representational state transfer. It's used to describe Web applications, which transfer the application's state to the client by traversing through links. The REST architectural style includes some guiding constraints. Systems which follow these constraints are called RESTful.

A RESTful API call is the process of a client application submitting a request to an API endpoint, the API server acting on that request, such as to retrieve data, and the server responding back to the client with a successful response that includes any data requested, or an error.

GraphQL

GraphQL is a query language for APIs as well as a runtime environment for filling those queries with data. A GraphQL schema is made up of object types, which define which kind of object you can request and the fields it contains. As queries come in, GraphQL validates the queries against the schema. GraphQL then executes the validated queries.

What is the goal of this beta?

We want to get feedback from our beta customers on the complete experience, such as getting started, Developer documentation, the app build flow, getting your app running, troubleshooting your app, and more.

How can I sign up for the beta?

You don't need to sign up. The GraphQL beta is available for your account. You can start using it now!

Can I use GraphQL with a free Zoom account?

No, you must have a Zoom Pro account or higher to use GraphQL.

Is GraphQL account level or user-managed?

Both. Depending on your access token scope and also the objects that you request. Graph QL uses the same authentication mechanism as our Rest APIs.

Can I use GraphQL outside of my Zoom Account?

For example, if you use GraphQL in your app and publish it, can users activate your app in their account and use GraphQL calls?

No, GraphQL are "bound" to the account that creates them, and are not intended for multi-tenancy like Zoom Marketplace Apps.

What app types can I use with GraphQL?

OAuth and Server-to-Server OAuth app types.

Is GraphQL available for the Video SDK API?

No, but this is something we are exploring. If you are interested in using GraphQL for the Video SDK API, please let us know.