Currently in active development with our trusted beta partners. Experience the next generation of aviation API technology.
BETA
Version: 2.4.0
License: MIT
## Servers
Test Server
```
https://test.fl3xx.com
```
## Security
### X-Api-Client-Id
Type: apiKey
In: header
Name: X-Api-Client-Id
### X-Auth-Token
Type: apiKey
In: header
Name: X-Auth-Token
## Download OpenAPI description
[FL3XX API](https://developer.fl3xx.com/_bundle/reference/@v2/index.yaml)
## Airports
Access comprehensive airport information.
**Business Value**
- Filter airports by various criteria including ICAO, IATA, FAA codes and local identifiers
- Support high-performance applications with optimized data retrieval
**Use Cases**
- Filter airports by specific codes for targeted data retrieval
- Integrate airport data into flight planning and scheduling systems
- Build airport selection interfaces with efficient pagination
### Get airport
- [GET /api/v2/airports/{airportCode}](https://developer.fl3xx.com/reference/v2/airports/paths/~1api~1v2~1airports~1%7Bairportcode%7D/get.md): This endpoint provides efficient access to airport data.
Features:
- Multiple filter options (ICAO, IATA, FAA, local identifier)
- Automatic exclusion of deleted/inactive airports
## Airport Fuel Prices
Manage and optimize airport fuel pricing data for your organization. These endpoints enable operators to efficiently update, remove, and bulk-manage fuel prices, supporting streamlined fuel order workflows and provider management.
**Business Value**
- Ensure accurate and up-to-date fuel pricing for all airport operations.
- Reduce manual effort and errors by enabling bulk updates and deletions.
- Support cost control and negotiation with providers through transparent pricing data.
- Enhance operational planning and financial forecasting with reliable fuel cost data.
**Use Cases**
- Update fuel prices for a specific airport to reflect new agreements or market changes.
- Remove outdated or incorrect fuel prices for compliance and data integrity.
- Perform bulk deletions to quickly adapt to network-wide pricing changes.
- Integrate with internal systems to automate fuel price management and reporting.
**Note:**
> The data managed by the Airport Fuel Prices endpoints is strictly bound to the context of the operator associated with the calling authentication token. All operations—creating, updating, or deleting airport fuel prices—apply only to the operator for which the provided token is valid.
### Get fuel prices for an airport
- [GET /api/v2/partners/airports/{airportCode}/fuel-prices](https://developer.fl3xx.com/reference/v2/airport-fuel-prices/paths/~1api~1v2~1partners~1airports~1%7Bairportcode%7D~1fuel-prices/get.md): Retrieve all fuel prices for a specific airport that were submitted by the partner associated with the authentication token.
Note: Only fuel prices associated with the operator linked to the authentication token will be returned.
### Update fuel prices for an airport
- [PUT /api/v2/partners/airports/{airportCode}/fuel-prices](https://developer.fl3xx.com/reference/v2/airport-fuel-prices/paths/~1api~1v2~1partners~1airports~1%7Bairportcode%7D~1fuel-prices/put.md): Update or set fuel prices for a specific airport. This endpoint allows partners to submit fuel pricing information that will be used for operational and financial processes.
Note: Only fuel prices associated with the operator linked to the authentication token can be updated.
Example Use Case: An operations manager needs to update the fuel price for a particular airport after receiving new rates from a provider. By using this endpoint, they can ensure that all future fuel orders and cost calculations use the most current pricing data.
### Delete all fuel prices for an airport
- [DELETE /api/v2/partners/airports/{airportCode}/fuel-prices](https://developer.fl3xx.com/reference/v2/airport-fuel-prices/paths/~1api~1v2~1partners~1airports~1%7Bairportcode%7D~1fuel-prices/delete.md): Delete all fuel prices for a specific airport that were submitted by the partner associated with the authentication token.
Note: Only fuel prices associated with the operator linked to the authentication token can be deleted.
Example Use Case: An operations manager needs to remove all fuel prices for an airport after a provider contract ends or when prices are no longer valid. Using this endpoint ensures that no obsolete pricing data is used in future fuel orders or cost calculations.
### Delete all fuel prices
- [DELETE /api/v2/partners/airport-fuel-prices](https://developer.fl3xx.com/reference/v2/airport-fuel-prices/paths/~1api~1v2~1partners~1airport-fuel-prices/delete.md): Delete all fuel prices submitted by the partner associated with the authentication token across all airports.
Note: Only fuel prices associated with the operator linked to the authentication token can be deleted in bulk.
Example Use Case: An operations manager needs to remove fuel prices for several airports after a system-wide update or contract changes. Using this endpoint ensures that obsolete pricing data is quickly cleared from all affected locations.
### Update individual fuel price
- [PUT /api/v2/partners/airport-fuel-prices/{fuelPriceId}](https://developer.fl3xx.com/reference/v2/airport-fuel-prices/paths/~1api~1v2~1partners~1airport-fuel-prices~1%7Bfuelpriceid%7D/put.md): Update a specific fuel price by its ID. This endpoint allows partners to modify individual fuel pricing records.
Note: Only fuel prices associated with the operator linked to the authentication token can be updated.
### Delete individual fuel price
- [DELETE /api/v2/partners/airport-fuel-prices/{fuelPriceId}](https://developer.fl3xx.com/reference/v2/airport-fuel-prices/paths/~1api~1v2~1partners~1airport-fuel-prices~1%7Bfuelpriceid%7D/delete.md): Delete a specific fuel price by its ID. This endpoint allows partners to remove individual fuel pricing records.
Note: Only fuel prices associated with the operator linked to the authentication token can be deleted.
## Webhooks
Manage webhook subscriptions for near real-time event notifications. These endpoints enable partners to create, manage, and monitor webhook subscriptions for receiving flight-related events and updates.
**Business Value**
- Receive near real-time notifications for flight events and updates.
- Automate integration workflows with external systems.
- Monitor flight operations and passenger changes in near real-time.
- Reduce polling overhead by using event-driven architecture.
**Use Cases**
- Subscribe to flight updates to sync data with external booking systems.
- Monitor passenger count changes for catering and ground service coordination.
- Track aircraft changes for maintenance and operational planning.
- Receive notifications for flight cancellations and time updates.
**Available Event Types:**
- `FLIGHT_CREATE`: New flight creation
- `FLIGHT_CANCEL`: Flight cancellation
- `FLIGHT_TIME_UPDATE`: Flight time changes
- `FLIGHT_AIRCRAFT_UPDATE`: Aircraft assignment changes
- `FLIGHT_AIRPORT_UPDATE`: Airport(s) changes
- `FLIGHT_POST_FLIGHT_STATUS`: Post-flight status updates
- `FLIGHT_MOVEMENT_UPDATE`: Flight movement updates
- `FLIGHT_PAX_COUNT_UPDATE`: Passenger count changes
- `FLIGHT_PAX_LIST_UPDATE`: Passenger list changes (e.g. new passengers, updated list, passenger document changes, etc.)
### Get webhook subscriptions
- [GET /api/v2/webhooks/subscriptions](https://developer.fl3xx.com/reference/v2/webhooks/getwebhooksubscriptions.md): Retrieve all webhook subscriptions for the authenticated partner and operator.
Features:
- Returns all active and inactive webhook subscriptions
- Filtered by partner and operator context
### Create a new webhook subscription
- [POST /api/v2/webhooks/subscriptions](https://developer.fl3xx.com/reference/v2/webhooks/createwebhooksubscription.md): Create a new webhook subscription for receiving near real-time event notifications.
Features:
- Validates callback URL format, only https is supported
- Sets automatic expiration date (1 month) for subscriptions
Example Use Case: An operations manager needs to receive near real-time notifications when flight times change. By creating a webhook subscription for FLIGHT_TIME_UPDATE events, they can automatically sync flight data with external systems.
### Get webhook subscription by ID
- [GET /api/v2/webhooks/subscriptions/{subscriptionId}](https://developer.fl3xx.com/reference/v2/webhooks/getwebhooksubscriptionbyid.md): Retrieve a specific webhook subscription by its unique identifier.
Features:
- Returns detailed subscription information
### Update webhook subscription callback URL or status
- [PATCH /api/v2/webhooks/subscriptions/{subscriptionId}](https://developer.fl3xx.com/reference/v2/webhooks/updatewebhooksubscription.md): Update the callback URL for an existing webhook subscription.
Features:
- Validates new callback URL format, only https is supported
- Updates subscription status to active or inactive
Example Use Case: An operations manager needs to change the webhook endpoint URL after migrating to a new server. Using this endpoint, they can update the callback URL without recreating the entire subscription.
### Delete a webhook subscription
- [DELETE /api/v2/webhooks/subscriptions/{subscriptionId}](https://developer.fl3xx.com/reference/v2/webhooks/deletewebhooksubscription.md): Delete a webhook subscription and stop receiving notifications for the associated event type.
Features:
- Immediately stops webhook deliveries
Example Use Case: An operations manager needs to stop receiving flight update notifications after completing a system migration. Using this endpoint, they can cleanly remove the webhook subscription.
### Renew a webhook subscription
- [POST /api/v2/webhooks/subscriptions/{subscriptionId}/renewals](https://developer.fl3xx.com/reference/v2/webhooks/renewwebhooksubscription.md): Renew an existing webhook subscription to extend its expiration date.
Features:
- Extends subscription expiration by 1 month from current expiration date.
- Subscriptions can only be renewed 5 days before expiration.
Example Use Case: An operations manager wants to continue receiving webhook notifications for an existing subscription. Using this endpoint, they can extend the subscription without recreating it.
### Get webhook deliveries
- [GET /api/v2/webhooks/deliveries](https://developer.fl3xx.com/reference/v2/webhooks/getwebhookdeliveries.md): Retrieve paginated webhook delivery history for the authenticated partner and operator.
Note: Only failed deliveries are supported at this time.
Features:
- Returns paginated delivery history with filtering and sorting
- Supports filtering by issue date and status
- Default sorting by issue date (descending)
Example Use Case: An operations manager needs to monitor webhook delivery to troubleshoot failed deliveries. Using this endpoint, they can review delivery history and identify patterns in webhook failures.
## Crew Qualifications
Manage crew qualifications and certifications. These endpoints enable partners to assign, update, and manage crew member qualifications including licenses, certifications, and associated documents.
**Business Value**
- Maintain accurate crew qualification records for compliance and safety.
- Streamline qualification assignment and management processes.
- Support document management for qualification certificates and licenses.
- Ensure crew members meet operational requirements and regulations.
**Use Cases**
- Assign new qualifications to crew members with license details and expiration dates.
- Update existing qualification information including license numbers and issuing authorities.
- Upload and manage qualification documents such as certificates and licenses.
- Retrieve qualification information for crew members and compliance reporting.
- Delete obsolete qualifications and associated documents.
**Note:**
> All crew qualification operations are bound to the operator context associated with the authentication token. Partners can only manage qualifications for crew members within their organization.
### Get crew qualifications
- [GET /api/v2/external/crew-qualifications](https://developer.fl3xx.com/reference/v2/crew-qualifications/getcrewqualifications.md): Retrieve crew qualifications with pagination and filtering capabilities.
Features:
- Filter by crew ID (required)
- Paginated results
Example Use Case: An operations manager needs to retrieve all qualifications for a specific crew member to verify compliance status and upcoming expiration dates.
### Assign a qualification to a crew member
- [POST /api/v2/external/crew-qualifications](https://developer.fl3xx.com/reference/v2/crew-qualifications/assignqualificationtocrew.md): Assign a new qualification to a crew member with license details, expiration dates, and other relevant information.
Features:
- Validates required fields including crew ID and qualification ID
- Supports license numbers, issuing authorities, and country information
- Handles pilot-in-command designations and base month calculations
Example Use Case: An operations manager needs to assign a new type rating qualification to a pilot after completing training. This endpoint allows them to create the qualification record with all necessary details.
### Get a crew qualification by ID
- [GET /api/v2/external/crew-qualifications/{crewQualificationId}](https://developer.fl3xx.com/reference/v2/crew-qualifications/getcrewqualificationbyid.md): Retrieve detailed information about a specific crew qualification including associated documents.
Features:
- Returns complete qualification details including document references
- Includes creation and update timestamps
Example Use Case: An operations manager needs to review the complete details of a specific qualification, including any uploaded documents, to verify compliance or prepare for audits.
### Update a crew qualification by ID
- [PATCH /api/v2/external/crew-qualifications/{crewQualificationId}](https://developer.fl3xx.com/reference/v2/crew-qualifications/updatecrewqualificationbyid.md): Update an existing crew qualification with new information.
Features:
- Updates qualification details including license numbers and dates
- Supports partial updates of qualification information
Example Use Case: An operations manager needs to update a qualification after a license renewal or when additional information becomes available.
### Delete a crew qualification by ID
- [DELETE /api/v2/external/crew-qualifications/{crewQualificationId}](https://developer.fl3xx.com/reference/v2/crew-qualifications/deletecrewqualificationbyid.md): Delete a crew qualification and remove it from the system.
Features:
- Permanently removes the qualification record
- Returns confirmation of deletion
Example Use Case: An operations manager needs to remove an obsolete qualification that is no longer valid or relevant for a crew member.
### Get document associated with a crew qualification
- [GET /api/v2/external/crew-qualifications/{crewQualificationId}/documents/{documentUuid}](https://developer.fl3xx.com/reference/v2/crew-qualifications/getcrewqualificationdocument.md): Download a document associated with a crew qualification.
Features:
- Downloads the actual document file
- Validates document ownership and access permissions
Example Use Case: An operations manager needs to download a qualification certificate or license document for verification or compliance purposes.
### Upload document associated with a crew qualification
- [POST /api/v2/external/crew-qualifications/{crewQualificationId}/documents](https://developer.fl3xx.com/reference/v2/crew-qualifications/uploadcrewqualificationdocument.md): Upload a document file to be associated with a crew qualification.
Features:
- Supports various document formats
- Associates the document with the specific qualification
- Returns document metadata including UUID for future access
Example Use Case: An operations manager needs to upload a scanned copy of a pilot's license or certificate to maintain digital records for compliance and verification.
### Delete document associated with a crew qualification
- [DELETE /api/v2/external/crew-qualifications/{crewQualificationId}/documents/{uuid}](https://developer.fl3xx.com/reference/v2/crew-qualifications/deletecrewqualificationdocument.md): Delete a document associated with a crew qualification.
Features:
- Permanently removes the document file
- Returns confirmation of deletion
Example Use Case: An operations manager needs to remove an outdated or incorrect document that was previously uploaded for a qualification.
### Get qualification types
- [GET /api/v2/external/qualification-types](https://developer.fl3xx.com/reference/v2/crew-qualifications/getqualificationtypes.md): Retrieve available qualification types and their details for use in crew qualification assignments.
Features:
- Returns paginated list of available qualifications
- Includes qualification metadata and configuration
Example Use Case: An operations manager needs to see all available qualification types in the system to properly assign qualifications to crew members.
### Get qualification type by ID
- [GET /api/v2/external/qualification-types/{id}](https://developer.fl3xx.com/reference/v2/crew-qualifications/getqualificationtypebyid.md): Retrieve detailed information about a specific qualification type.
Features:
- Returns complete qualification configuration and metadata
- Includes validity periods, grace periods, and relation information
Example Use Case: An operations manager needs to understand the specific requirements and configuration of a qualification type before assigning it to a crew member.
## Flights
Access comprehensive flight information and data. These endpoints enable partners to retrieve flight details with advanced filtering and pagination capabilities.
**Business Value**
- Retrieve flight data with flexible filtering by date ranges.
- Support high-performance applications with optimized data retrieval and pagination.
- Access essential flight information including schedules, aircraft assignments, and passenger counts.
**Use Cases**
- Retrieve flights within a specific date range for operational planning.
- Integrate flight data into external systems for scheduling and logistics.
- Monitor flight schedules and aircraft assignments in real-time.
- Build flight tracking and reporting dashboards with paginated results.
### Get flights
- [GET /api/v2/flights](https://developer.fl3xx.com/reference/v2/flights/getflights.md): Retrieve flights with pagination and filtering capabilities. This endpoint provides access to simplified flight information including schedules, aircraft assignments, airports, and passenger counts.
Features:
- Filter by estimated blocks-off date and time range (required) using the BTW (between) operator
- Paginated results with configurable limit (10-50) and offset
- Default sorting by estimated blocks-off date and time (descending)
- Returns flight data including arrival and departure airport details, quote information, and workflow type
Response Data:
- Flight identification (ID, flight number, tail number)
- Quote information (quote ID, external reference, identifier)
- Time estimates (blocks-off and blocks-on estimated times)
- Airport details (arrival and departure airports with ICAO, IATA, FAA codes)
- Passenger and trip information
- Customer and account identifiers
- Workflow type and custom workflow name
Example Use Case: An operations manager needs to retrieve all flights scheduled between two dates to plan crew assignments and resource allocation. The endpoint returns paginated results with complete airport information for both departure and arrival locations.
## Aircraft
Access comprehensive aircraft and fleet information. These endpoints enable partners to retrieve aircraft data including status, specifications, and operational details.
**Business Value**
- Retrieve complete fleet information with active and inactive aircraft.
- Support fleet management and operational planning with detailed aircraft data.
- Access aircraft specifications including capacity, category, and home base information.
**Use Cases**
- Retrieve fleet data for operational planning and scheduling.
- Integrate aircraft information into external systems for maintenance and logistics.
- Monitor aircraft status and availability across the fleet.
- Build fleet management dashboards with paginated results.
### Get fleet data
- [GET /api/v2/aircraft](https://developer.fl3xx.com/reference/v2/aircraft/getfleet.md): Retrieve aircraft fleet data with pagination capabilities. This endpoint provides access to comprehensive aircraft information including status, specifications, and operational details for both active and inactive aircraft.
Features:
- Returns both active and inactive aircraft in the fleet
- Paginated results with configurable limit (10-50) and offset
- Default sorting by updated date and time (descending)
- Returns complete aircraft details including home base airport information
Response Data:
- Aircraft identification (ID, tail number, name)
- Operational details (type of use, status, number of seats)
- Aircraft category (e.g., HEAVY_JET, LIGHT_JET, HELICOPTER)
- Home base airport information (ICAO, IATA, FAA codes, name, local identifier, AID)
- Timestamps (creation and last update dates)
- Additional notes and metadata
Example Use Case: An operations manager needs to retrieve the complete fleet list to plan aircraft assignments and monitor aircraft status across the organization. The endpoint returns paginated results with detailed airport information for each aircraft's home base.