REST API

AviationAlley REST API

v1.0.0

Programmatic access to AviationAlley training-center data. Auth is Bearer token. Mint keys in /app/settings/integrations. Each key is scoped to one center; the token's prefix indicates environment (`aa_live_` or `aa_test_`). Pagination is keyset-based: pass `cursor=<previous nextCursor>` and `limit` (1–200, default 50). Responses look like `{ data: [...], pagination: { limit, nextCursor: string | null } }`.
Download OpenAPI JSONEndpoint index

Servers

  • https://aviationalley.com/api/v1— Default

Authentication

Every endpoint requires a Authorization: Bearer aa_live_… header. Mint keys in Settings → Integrations (OWNER/ADMIN only).

Endpoints

get/traineestrainees:read

List trainees

Query parameters

Limitstring
Cursorstring
get/bookingsbookings:read

List simulator bookings

Query parameters

fromstring (date-time)
tostring (date-time)
statusstringSCHEDULED | IN_PROGRESS | COMPLETED | CANCELLED | NO_SHOW
Limitstring
Cursorstring
get/work-ordersworkorders:read

List work orders

Query parameters

statusstringOPEN | IN_PROGRESS | AWAITING_PARTS | COMPLETED | CANCELLED
prioritystringLOW | NORMAL | HIGH | CRITICAL
simulatorIdstring (uuid)
Limitstring
Cursorstring
get/invoicesinvoices:read

List invoices

Query parameters

statusstringDRAFT | SENT | PAID | VOID | OVERDUE
fromstring (date-time)
tostring (date-time)
Limitstring
Cursorstring
get/compliance-itemscompliance:read

List compliance items

Query parameters

statusstringCOMPLIANT | DUE_SOON | OVERDUE | IN_PROGRESS | WAIVED
categorystringPART_142 | NSP | AIRCRAFT_EVALUATION | INSTRUCTOR_CURRENCY | FACILITY | OTHER
Limitstring
Cursorstring
get/flight-logflight_log:read

List flight-log entries

Query parameters

userIdstring (uuid)Filter to one pilot.
fromstring (date)YYYY-MM-DD lower bound (inclusive).
tostring (date)YYYY-MM-DD upper bound (inclusive).
Limitstring
Cursorstring
get/crewcrew:read

Crew duty status snapshot

Query parameters

rolestringFilter to one role (INSTRUCTOR, DISPATCHER, etc.).
atstring (date-time)Anchor time — defaults to now. Useful for forecasting.

Webhook events

Configure endpoints in Settings → Integrations. Verify the X-AviationAlley-Signature header (HMAC-SHA256 hex of the raw body using the endpoint signing secret).

booking.createdbooking.updatedbooking.cancelledbooking.completedworkorder.createdworkorder.updatedworkorder.completedinvoice.createdinvoice.paidinvoice.voidedtrainee.createdtrainee.updatedcompliance.due_sooncompliance.overduebidding.awards_publishedquote.createdquote.acceptedquote.declined