Exploring the GraphQL API with Apollo Sandbox
We highly recommend using Apollo Sandbox as the best way to browse, explore, and test the Submarine GraphQL API. Apollo Sandbox gives you full visibility into our schema, including all available queries, mutations, subscriptions, and types — complete with inline documentation and autocomplete.
Getting Started
1. Open Apollo Sandbox
Navigate to the Apollo Sandbox Explorer:
👉 https://studio.apollographql.com/sandbox/explorer
2. Get Your API Token
You'll need a Bearer token to authenticate your requests:
- Log in to the Submarine app.
- Go to Settings → API Access.
- Copy your API token.
3. Configure Connection Settings
Open the Connection Settings panel in Apollo Sandbox and enter the following:
Setting | Value |
Endpoint | https://api.submarineplatform.com/graphql |
Subscriptions | wss://api.submarineplatform.com/graphql |
Implementation | auto-detect |
Include cookies | Off |
Under Shared Headers, add the following:
Header Name | Value |
Authorization | Bearer <your-api-token> |
Replace <your-api-token> with the token you copied from the Submarine app.
4. Explore the API
Once connected, Apollo Sandbox will automatically fetch the schema. You can:
- Browse the schema — Use the documentation panel on the left to explore all available queries, mutations, and subscriptions.
- Build queries visually — Click fields in the schema explorer to construct queries without writing them by hand.
- Run requests — Execute queries and mutations directly against the Submarine API and see results in real time.
- View type definitions — Inspect input types, enums, and object types to understand the shape of request and response data.
Tip: Apollo Sandbox polls the endpoint for schema changes every 5 seconds when Auto Update is enabled (on by default), so you'll always be working with the latest schema.
Why Apollo Sandbox?
Apollo Sandbox provides a significantly richer experience than static documentation for exploring a GraphQL API. It offers real-time schema introspection, query autocompletion, and the ability to test requests instantly — making it the fastest way to understand what the Submarine API can do and how to integrate with it.
Need Help?
If you run into any issues connecting to the API or have questions about available operations, reach out to our team at support@getsubmarine.com.