Set up API Playground
Learn how to set up the Sprinto API Playground to explore and test the Sprinto Developer API directly from your browser.
The Sprinto API Playground is a browser-based GraphQL explorer that lets you interact with the Sprinto Developer API without installing any client libraries or GraphQL tools.
You can use the playground to explore the API schema, test queries and mutations, and validate responses in real time.
The API Playground must be configured each time your browser session expires.
Prerequisites
Before setting up the API Playground, ensure that you have:
A valid Sprinto account with administrator privileges
A valid API key generated from the Sprinto application
For detailed instructions, refer to the guide on generating an API key.
Access the API Playground
Open the API Playground in your preferred web browser based on your data residency region:
United States: Sprinto API Playground
Europe: Sprinto API Playground
India: Sprinto API Playground
Configure the API Playground
Follow these steps to configure the API Playground for your session.
Step 1: Open connection settings
From the top bar of the API Playground, click the Settings icon to open the Connection settings panel.
Step 2: Add shared headers
In the Shared headers section, add the following key–value pairs:
api-key
<your API key>
apollo-require-preflight
true
These headers authenticate your requests and ensure proper schema loading.
Step 3: Save the configuration
Click Save to apply the changes.
Introspect the schema
Once the headers are saved:
The API automatically introspects the schema, or
You can manually trigger introspection by clicking Refetch Schema from the explorer page
Successful introspection loads the full API schema into the playground.
Verify successful setup
After introspection completes, the playground displays the available root types, grouped into:
Query
Mutation
This confirms that the API Playground is correctly configured and ready for use.
What you can do next
Once the API Playground is set up, you can:
Browse available queries and mutations
Inspect required arguments and response types
Test paginated queries
Validate mutations before implementing them in your application
Next steps
After setting up the API Playground, you may want to:
Make your first API call using the playground
Review the API structure to understand available operations
Learn how pagination works for large datasets
Last updated