🚧
Disclaimer
The GraphQL service is provided without guarantee – it can be taken down, its usage changed or restricted without prior notice. Also the formatting of results/responses may change.
Please use at your own risk.
You can use the GraphQL service for testing and pulling small exports of data, as a manual exploration and reporting tool.
For a sustainable service (integration scenarios, automation tasks) we strongly recommend using our REST API endpoints exclusively, or get in touch to learn about shyftconnect integrations.

Overview

GraphQL offers a simplified option to pull custom reports from our database by intuitively combining API-queries to different endpoints into one query. Please note, however, that the tool has a limited functionality and does not offer access to all endpoints availabe through direct usage of our API.

Key concepts

With GraphQL, developers can request exactly the data they need while avoiding over- and underfetching:

Overfetching: Requesting too much data, e.g. data from fields that are of no interest for the current use case
Underfetching: Requesting too little data (by not querying relevant API endpoints)

Get started

This is the link to our GraphQL page.

📘
Hint
As an alternative, you can use this link, which will fill the same page with a very basic query and default values in the "headers" and "variables" section (on the bottom of the page).
Just change

the headers section (use your e-mail address and API token)

the variables section (use your company id) and try it out by clicking on the button labelled "Example Query".

From this point, you can experiment by changing the query.

More info

Documentation and tutorials for the GraphQL service can be found by clicking on the question mark in the upper right-hand corner of our GraphQL page.