Quickstart

First API request in 5 minutes. This guide walks you through creating an API key, sending your first request, and processing the response.

Prerequisites

You need an active AeroSelect account with Admin or Manager permissions to create API keys.
1

Create API key in AeroSelect

Log in to AeroSelect and navigate to Settings → API Access → API Keys. Click "Create new API key", enter a descriptive name (e.g. "HRIS Integration") and select the required scopes. Click Create and save the generated key immediately — it will only be shown in plain text once.

2

Send your first request

Test your key with a simple GET request to the jobs list. Replace ak_live_... with your actual API key.

TerminalBash
curl https://api.aeroselect.io/api/v2/external/jobs \
  -H "X-API-Key: ak_live_YOUR_KEY_HERE"
3

Process the response

On success you receive a JSON response with a data array and a meta object for pagination.

ResponseJSON
{
  "data": [
    {
      "id": 1,
      "title": "First Officer A320",
      "location": "Frankfurt (FRA)",
      "status": "online",
      "created_at": "2026-05-01T10:00:00Z"
    }
  ],
  "meta": {
    "total": 24,
    "page": 1,
    "per_page": 15,
    "last_page": 2
  }
}
4

Integrate with Node.js

Example for integrating into a Node.js application using the native fetch API.

integration.jsJavaScript
const API_KEY = process.env.AEROSELECT_API_KEY;
const BASE_URL = "https://api.aeroselect.io/api/v2/external";

async function getJobs() {
  const response = await fetch(`${BASE_URL}/jobs`, {
    headers: {
      "X-API-Key": API_KEY,
      "Accept": "application/json",
    },
  });

  if (!response.ok) {
    const error = await response.json();
    throw new Error(error.message);
  }

  return response.json();
}

const { data: jobs, meta } = await getJobs();
console.log(`${meta.total} Jobs gefunden`);

Available Scopes

When creating an API key you choose which scopes it should have. Grant only the minimum required permissions (Principle of Least Privilege).

FeldTypPflichtBeschreibung
jobs:readstringOptionalRead jobs and job listings
jobs:writestringOptionalCreate, edit jobs and change status
applications:readstringOptionalRead applications and their details
applications:writestringOptionalSubmit applications, change status and add notes
candidates:readstringOptionalRead candidate profiles and contact data
candidates:writestringOptionalEdit candidate profiles
settings:readstringOptionalRead company settings and offices
settings:writestringOptionalManage offices and settings
talent_pool:readstringOptionalRead Talent Pool entries
talent_pool:writestringOptionalManage Talent Pool
calendar:readstringOptionalRead calendar and appointments
analytics:readstringOptionalRecruiting statistics and reports

Python Example

integration.pyPython
import os
import requests

API_KEY = os.environ["AEROSELECT_API_KEY"]
BASE_URL = "https://api.aeroselect.io/api/v2/external"

def get_jobs(page=1, per_page=15):
    response = requests.get(
        f"{BASE_URL}/jobs",
        headers={"X-API-Key": API_KEY},
        params={"page": page, "per_page": per_page},
    )
    response.raise_for_status()
    return response.json()

result = get_jobs()
print(f"Gefunden: {result['meta']['total']} Jobs")
for job in result["data"]:
    print(f"- {job['title']} ({job['location']})")

Next Steps

You have successfully sent your first API request. Now you can dive deeper: