Skip to main content

Client Setup

Playground (in the browser)​

The quickest way to try the API is the Playground, the GraphiQL editor embedded in this documentation and reachable from the top navigation bar. It runs in your browser and calls the API endpoint directly:

  1. Choose the environment: staging (the default, safe for experiments) or production (operations affect real data: a mutation is sent only after you confirm it).
  2. Paste your access token in the toolbar: the Authorization: Bearer <token> header is added to every request for you (see Authentication to get a token). The token is sent only to the selected endpoint and stored only in your browser: per tab by default, or across sessions if you tick Remember token in this browser.
  3. Write your operation in the left pane and run it with the ▶ button (or Ctrl+Enter). Autocompletion (Ctrl+Space), the Docs panel and the Explorer (in the left sidebar: tick the fields and arguments you want and the operation is written for you) come from the same schema as this documentation.

Every example request in the guides has an Open in playground action (hover the request block): it loads the operation in the editor, ready to be adapted with your own ids and codes and executed. Whatever the API returns is shown as is: data, GraphQL errors (see Errors) and the extensions with your rate-limit balance.

Desktop GraphQL clients​

Any GraphQL client (Altair, Postman, Insomnia, …) works the same way: point it at the endpoint of the environment you want to use and add the Authorization: Bearer <token> header to every request (see Authentication). The client loads the schema from the endpoint, so you get the same documentation and autocompletion as in the Playground.