Working with the GraphQL API

HazelBase's public API is built using GraphQL, the same API we use internally to build our platform and power our clients. This means you can access the same data and perform the same actions as you would as any other client.

If you are new to GraphQL, we recommend checking out the official documentation along with our Quickstart example. Both Github and Apollo also have great resources on using GraphQL.

Endpoint

HazelBase's GraphQL API is available at https://api.hazelbase.com/graphql. It supports introspection so you can query the whole schema. You can use this endpoint to access all the data and perform all the actions that are available in the API.

Quickstart

The best way to get started with the GraphQL API is to complete the quickstart.

Exploring the API

Since the endpoint supports introspection, any number of UIs can generate an interactive UI, such as Apollo's Explorer Sandbox. We have a prepopulated example, using a variable named phoneNumber and the ApiKey header preset here on the Apollo Explorer Sandbox.