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
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.
Send your first request
Test your key with a simple GET request to the jobs list. Replace ak_live_... with your actual API key.
curl https://api.aeroselect.io/api/v2/external/jobs \
-H "X-API-Key: ak_live_YOUR_KEY_HERE"Process the response
On success you receive a JSON response with a data array and a meta object for pagination.
{
"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
}
}Integrate with Node.js
Example for integrating into a Node.js application using the native fetch API.
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).
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| jobs:read | string | Optional | Read jobs and job listings |
| jobs:write | string | Optional | Create, edit jobs and change status |
| applications:read | string | Optional | Read applications and their details |
| applications:write | string | Optional | Submit applications, change status and add notes |
| candidates:read | string | Optional | Read candidate profiles and contact data |
| candidates:write | string | Optional | Edit candidate profiles |
| settings:read | string | Optional | Read company settings and offices |
| settings:write | string | Optional | Manage offices and settings |
| talent_pool:read | string | Optional | Read Talent Pool entries |
| talent_pool:write | string | Optional | Manage Talent Pool |
| calendar:read | string | Optional | Read calendar and appointments |
| analytics:read | string | Optional | Recruiting statistics and reports |
Python Example
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:
- Authentication & Scopes — All authentication options and security best practices
- AeroHire Jobs API — Full documentation of all job endpoints
- Errors & Status Codes — Error handling and retry strategies