If your API queries aren’t working as expected—whether they return validation errors, unexpected results, or fields that don’t match what you see in documentation—this guide will help you diagnose and fix the issue.
Common Symptoms
You may be experiencing a query-related issue if:
Your query returns unexpected or incomplete results
You see validation errors
The API reports that a field doesn’t exist
You encounter schema mismatches between your query and the available fields
Your query works in one environment but not another
These issues are usually caused by typos, schema misunderstandings, or using outdated or internal-only examples.
How to fix query errors
Follow these steps to quickly identify and resolve the most common issues:
-
Test your query in the GraphQL Playground. Paste your full query into the GraphQL Playground. This is the fastest way to see what’s going wrong, as the Playground will:
Highlight syntax errors
Flag invalid fields
Suggest corrections (“Did you mean…?”)
-
Validate your query against the live third-party schema.
-
Check for syntax and spelling errors. Even a small formatting issue can cause a query to fail. Many query errors come from:
Typos in field names
Incorrect punctuation
Misplaced brackets
-
Missing required parameters
-
Confirm you’re using the third-party API schema. Some customers reference internal engineering documentation or examples found online. The third-party API uses a restricted schema, which may not include the same fields or mutations.
Make sure you:
Compare your query against the schema shown in the GraphQL Playground: if a field doesn’t appear in the Playground schema tab, it’s not available through the public API
-
Avoid copy/pasting from internal or outdated sources
-
Try a simplified version of your query. If you’re unsure where the issue is coming from:
Start with a minimal query
Add fields back one at a time
-
Identify the specific part causing the error
This helps isolate whether the issue is with a field, a nested object, or a required argument.
-
Compare your query to working examples. Review sample queries in our API documentation to see:
Correct syntax
Valid field names
Supported structures
-
Required arguments
Modeling your query after a known working example often resolves schema mismatches.
Still having trouble?
If you’re stuck, feel free to contact our Support team with:
The full query you’re trying to run
The exact error message you’re receiving
A screenshot of the issue from the GraphQL Playground
We’re happy to help troubleshoot your integration.