This document describes how to use the koppla GraphQL API.

<aside> 💡 This document is shared with people outside of koppla.

</aside>

Schema

The live schema of our API can be found here. It’s automatically updated whenever a new schema is released.

Endpoint

The API can be accessed via https://api.koppla.de/api/graphql/v1/

Authentication

Legacy

Pass JWT token via Authorization header of request. The token can be obtained via the web app. The token will grant access to the same resources that your user has.

API Key 🆕

It’s possible to use the GraphQL API with a permanent API key. The key doesn’t expire and is therefore suitable for custom integrations.

The API key can be restricted to tenants or specific projects.

Tenant access

Tenant access grants read access to tenant memberships and project access for every project of that tenant.

Project access

This type of access grants read permissions to the following data of a project

• schedule data (activities, milestones, dependencies, pauses, calendars)