Integrations
Learn how to make use of integrations with third parties
Using the Atleta API
This article is intended for developers of an application. As an organizer, you can connect your project to their app via a link provided by the app creators.
To use the Atleta GraphQL API, you need an access token. You can obtain this access token by creating an app in your project. Organisers can connect their projects to your app after you have created it, using your connection link.
Creating an app
To create an app, go to the project settings. Click on the name of your organisation in the navigation bar, select Settings, and then go to the ‘API’ tab. Here you will find an overview of all apps created within your project.
Click the ‘Add app’ button and enter a name for the app here. This name is shown to organisers on the page where they connect to your app. You can also select the permissions your app needs to function. It is recommended to request as few permissions as possible.
When you save the app, the API token is shown once. Store it in a secure location (treat this token as if it were a password). Once you click ‘OK’, we can no longer retrieve your access token.
Connecting your app to other projects
To gain access to projects of organisers you work with, you can share the connection link. To do this, go to the ‘Connected projects’ tab on the app details page. Here you will see a list of all connected projects, as well as the link to share with organisers. If you have just created your account, a message may appear about verifying your project.
You can visit your own connect link to see what it looks like for the other organisers. They can select a project they want to authorise for your app and view the permissions you have requested. After a connection is made, your app appears in the ‘Integrations’ tab of their project settings. Here they can revoke access if they wish.
Using the GraphQL API
Atleta offers a GraphQL API at: https://atleta.cc/api/graphql
Part of this GraphQL API is publicly accessible. To access data from your project, an access token is required. You can include this in the following HTTP header, replacing $token with your token:
An overview of all available fields can be found at: https://docs.atleta.cc/graphql/reference/. In addition, the GraphQL API supports ‘introspection’, allowing you to see which fields are available. We are happy to refer you to the general documentation on how GraphQL works.
The main entry point in our API is the ‘project’ property of the Query type. This requires a Project ID, which you can find in the URL of the dashboard where you connected your app: the four characters after atleta.cc/b/ are those of your project.
An example query that retrieves the name of project TEST looks as follows:
