GraphQL API Documentation

What is GraphQL?

GraphQL is a query language for APIs. Unlike REST, you send a single request to one endpoint and specify exactly what data you need. The response matches the shape of your query. This reduces over-fetching and lets you get related data in one round trip.

Our API structure

The API is split into schemas by domain (user, company, order). Each schema has its own endpoint:

POST /graphql/user
POST /graphql/company
POST /graphql/order

How to send a request

Send a POST with JSON body. Most endpoints require authentication via the X-API-KEY header.

Content-Type: application/json
X-API-KEY: your_api_key

{
  "query": "query { me { id email } }",
  "variables": {}
}

Queries vs Mutations

• query Use for reading data — fetch users, orders, companies, etc. No side effects.
• mutation Use for changes — create, update, delete. Replaces POST/PUT/PATCH/DELETE in REST.

Example: Query

query {
  myCompanies {
    id
    name
  }
}

Example: Mutation with variables

mutation UpdateUser($input: UpdateUserInput!) {
  updateUser(input: $input) {
    id
    email
  }
}

// Variables:
{ "input": { "name": "John" } }

Quick start

1. Register or log in at test.supl.app.
2. Create an API key in the user schema for programmatic access.
3. Use GraphiQL to explore schemas and test queries before integrating.