Connecting to GraphQL API's

📘

NOTICE TO BETA USERS (That's You)

The API endpoints, as well as this documentation, is being provided to you as part of an early access / beta program. The goal of this beta is to collect feedback and make further improvements; therefore, (please, please please) DO NOT build any critical workflows or integrations based on the current state of our APIs, because there is a good chance that we will be introduce changes that will break your script/application/integration. Again - and we cannot emphasize this enough - these APIs are going to change, so treat anything built on top of them as likely throwaway work.

Each of our GraphQL pages has a URI indicating the location of the graph and a copyable text schema. Our recommended work flow is to explore these schemas interactively by using the GraphiQL app.

1. Download and install the [GraphiQL UI] (https://github.com/skevy/graphiql-app)
2. Input the appropriate URI to your workspace and graph
3. Click "Edit HTTP Headers" then "Add Header" with the header name apikey and the value of your generated credential

Once this is done clicking on "Docs" should allow you to view the schema.

Common Patterns

Pagination

Pagination in our GraphQL API's is generally implemented using cursors following the [relay spec] (https://relay.dev/graphql/connections.htm). Note that only forward pagination is implemented.