Getting Started

If you're new to the AirSaas API, you've come to the right place :)

The AirSaas API allows you to interact with your AirSaas data from an outside system. For example you can use it to extract all your projects, synchronize them with your project management platform, display the list of decisions in your favorite BI tool, etc.

1. API Key

One important concept to remember is that you will interact with the API using your own personal credentials, meaning that all the operations you will do will use your personal access rights: you will only be able to read the projects you have access to, or update the decisions that you're allowed to modify. Just like what you can do directly on AirSaas.

The access to the API is done per workspace. For each workspace you belong to, you will be given one API Key. That API Key is your credential to use with the API. To obtain your API Key, follow this guide.

2. Authentication

Requests to the API use the HTTP Authorization header to both authenticate and authorize operations.

All endpoints documented in this reference require to use the Authorization header with a valid API Key. The header must be in the following format: Authorization: Api-Key YOUR_API_KEY_HERE.

To read more on this subject, read the dedicated authentication reference.

3. Your first API call

Now you are ready to make your first API call.

Let's fetch some information about yourself and your workspace. To do that will use the Profile endpoint.

curl --request GET \
     --url https://api.airsaas.io/v1/profile \
     --header 'Authorization: Api-Key YOUR_API_KEY_HERE' \
     --header 'accept: application/json'

This will give you a response like this:

{
    "id": "2d23a098-a41d-4ea8-92ed-0131ff7ee021",
    "given_name": "John",
    "family_name": "Doe",
    "name": "John Doe",
    "initials": "JD",
    "picture": "url...",
    "current_position": "Project Manager",
    "workspace": {
        "id": "e1786260-318d-5cb6-8df8-03966d3d78d6",
        "name": "Acme",
        "slug": "acme",
        "logo": "url..."
    }
}

In this response you will find information about you and the workspace corresponding to you API Key.

You can play with this profile endpoint and other endpoints in our interactive reference .