Skip to content
/
Get document associated w...

FL3XX API (2.0.0)

FL3XX API v2.0 - Beta Release

Currently in active development with our trusted beta partners. Experience the next generation of aviation API technology.

BETA
Download OpenAPI description
index.json
index.yaml
Overview
URL

https://www.fl3xx.com

FL3XX Integration Support

integrations@fl3xx.com

License

MIT

Languages
Servers
Test Server

https://test.fl3xx.com/

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

Operations

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.

Operations

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.)
Operations

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.

Operations

Delete a crew qualification by ID

Request

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.

Security
X-Api-Client-Id and X-Auth-Token
Path
crewQualificationIdstringrequired

The unique identifier of the crew qualification to delete

Example: qual-12345
curl -i -X DELETE \
  https://test.fl3xx.com/api/v2/external/crew-qualifications/qual-12345 \
  -H 'X-Api-Client-Id: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Successfully deleted crew qualification

Bodyapplication/json
deletedboolean

Indicates whether the deletion was successful

Example: true
Response
application/json
{
  "deleted": true
}

Get document associated with a crew qualification

Request

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.

Security
X-Api-Client-Id and X-Auth-Token
Path
crewQualificationIdstringrequired

The unique identifier of the crew qualification

Example: qual-12345
documentUuidstringrequired

The unique identifier of the document to download

Example: doc-uuid-67890
curl -i -X GET \
  https://test.fl3xx.com/api/v2/external/crew-qualifications/qual-12345/documents/doc-uuid-67890 \
  -H 'X-Api-Client-Id: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Successfully retrieved document

Bodyapplication/octet-stream
string(binary)

Upload document associated with a crew qualification

Request

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.

Security
X-Api-Client-Id and X-Auth-Token
Path
crewQualificationIdstringrequired

The unique identifier of the crew qualification

Example: qual-12345
Bodymultipart/form-datarequired
filestring(binary)required

The document file to upload

curl -i -X POST \
  https://test.fl3xx.com/api/v2/external/crew-qualifications/qual-12345/documents \
  -H 'Content-Type: multipart/form-data' \
  -H 'X-Api-Client-Id: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -F file=string

Responses

Successfully uploaded document

Bodyapplication/json
idinteger(int64)

Unique identifier for the document

Example: 12345
uuidstring

Unique identifier for the document file

Example: "doc-uuid-67890"
originalNamestring

Original filename of the uploaded document

Example: "pilot_license.pdf"
fileSizeinteger(int64)

Size of the document file in bytes

Example: 1024000
creationDatestring(date-time)

Date and time when the document was uploaded

Example: "2024-01-15T10:30:00.000Z"
customNamestring

Custom name assigned to the document

Example: "Captain License"
imageSizeXinteger

Width of the image in pixels (if applicable)

Example: 1920
imageSizeYinteger

Height of the image in pixels (if applicable)

Example: 1080
isThumbnailboolean

Whether this is a thumbnail version of the document

Example: false
Response
application/json
{
  "id": 12345,
  "uuid": "doc-uuid-67890",
  "originalName": "pilot_license.pdf",
  "fileSize": 1024000,
  "creationDate": "2024-01-15T10:30:00.000Z",
  "customName": "Captain License",
  "imageSizeX": 1920,
  "imageSizeY": 1080,
  "isThumbnail": false
}