We have two distinct environments for our GraphQL API: Sandbox and Production.
Our GraphQL API uses an OAuth 2.0 client credentials flow to authenticate clients.
Our GraphQL API Explorer allows you to explore our GraphQL schema and test out queries and mutations against our Sandbox environment.
Our GraphQL API loosely follows the GraphQL Cursor Connections Specification made popular by Relay. When results need to be paginated, the query or field will accept first String where first is an optional number of results to return and after is an optional endCursor from a previous page. We return a Result type with two sibling fields: nodes (the list of results) and pageInfo. Learn more about the PageInfo type here.
This document lists recent and upcoming breaking changes to our GraphQL API schema. We will notify partners in advance of releasing any breaking changes to our API and provide ample time for you to adjust your queries and mutations accordingly.
This document lists all recent and upcoming changes to our GraphQL API schema.