Skip to main content
The Beebole GraphQL API is self-describing through introspection, so you can explore the full schema — every type, query, mutation, argument, and field — directly from a GraphQL client. Beebole does not ship a separate hosted schema browser; instead, you point any standard GraphQL tool at the API endpoint and let introspection reveal the schema.
Introspection is enabled for API-key requests against the Beebole GraphQL endpoint. There is nothing to turn on in your account — any GraphQL client that supports introspection can read the schema as soon as it can authenticate.

​
The endpoint and authentication

Schema exploration uses the same endpoint and authentication as every other API call: 
POST https://app.beebole.com/graphql
Authenticate by sending your API key in the apikey HTTP header: 
apikey: YOUR_API_KEY
For where to find your key, see Introduction to the Beebole API.

​
Exploring the schema with introspection

Introspection is a built-in GraphQL feature: the schema can be queried like any other data. A minimal introspection query lists every type the API exposes: 
{
  __schema {
    types {
      name
      kind
    }
  }
}
You can also introspect a single type to see its fields, their types, and any descriptions: 
{
  __type(name: "Person") {
    name
    description
    fields {
      name
      description
      type {
        name
        kind
      }
    }
  }
}
Most GraphQL clients run a full introspection query automatically when you connect, so you rarely write these queries by hand — the client uses the result to power autocomplete, type-aware validation, and a browsable schema view.

​
Connecting a GraphQL client

Any GraphQL client or IDE that supports introspection can explore the Beebole schema. Configure it with the endpoint URL and the apikey header:
1

Set the endpoint URL

Point the client at https://app.beebole.com/graphql.
2

Add the API key header

In the client’s HTTP headers configuration, add a header named apikey with your key as the value.
3

Load the schema

Run the client’s introspection or “refresh schema” action. The client fetches the schema and enables documentation browsing, autocomplete, and validation.
This works with desktop GraphQL IDEs, GraphQL plugins for code editors, and command-line tools that fetch a schema for code generation. Because the schema comes from introspection, it always reflects the live API — there is no separate schema file to download or keep in sync.

​
Built-in GraphiQL at the endpoint

Beebole serves a GraphiQL IDE — including the schema Explorer panel — directly at the API endpoint. Open https://app.beebole.com/graphql in a browser to load it. GraphiQL provides a query editor, a documentation explorer for browsing types and fields, and an Explorer panel for building queries by clicking through the schema.
GraphiQL sends requests to the same POST /graphql endpoint, so it follows the same authentication rules. Use GraphiQL’s headers editor to add your apikey header before running introspection or queries.

​
Related content

Introduction

The endpoint, API-key authentication, and how to send your first request.

Queries

All available GraphQL read operations in the Beebole API.

Mutations

All available GraphQL write operations in the Beebole API.