API Schema

View our up to date schema by visiting our sandbox GraphQL playground . You can view the schema by clicking either the docs tab or the schema tab.

The docs tab is essentially an open api for all our queries and mutations. It contains a list of all our queries and mutations as well as the inputs and responses. This tab is more human readable and searchable than the schema tab. You can expand an input or an object by clicking the arrow on the right side of that field. Some fields have comments explaining how they are used and any restrictions or formatting they have. You have to expand the field to see this additional information.

The schema tab is the graphQL schema file. It has all the types, queries and mutations defined but it is not easily searchable. This tab is good to reference if you prefer to look at the schema definition as code but it is missing the helpful annotations on formatting, restrictions and usage that you can see in the docs tab.