API Overview
Last updated
Was this helpful?
Last updated
Was this helpful?
GraphQL is a query language for our API. It's beneficial for large datasets as it allows for selecting specific objects and fields rather than committing to all data returned by a REST API endpoint. GraphQL is very beneficial for large datasets as it provides for greater flexibility and higher performance API endpoints. Send a GraphQL query to our API and get exactly what you need. GraphQL queries always return predictable results.
Additionally, it allows us to evolve our API without the need for versioning.
If you're not familiar with GraphQL, we suggest that you check it out from the link below.
While typical REST APIs require loading from multiple URLs, GraphQL APIs get all the data your app needs in a single request. Apps using GraphQL can be quick even on slow mobile network connections.
Our GraphQL API is located at:
Our GraphQL is self-documenting. As such, documentation is provided from our GraphQL Explorer endpoint that allows for exploration, documentation, and live queries testing against our API.
Visit our GraphQL Explorer tool here:
Our GraphQL API endpoint requires authentication with an API token.
Generate user API token
Example Queries