Skip to content
/
Assign a qualification to...

FL3XX API (2.4.0)

FL3XX API v2.0 — Beta Release

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

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, 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:

Data managed by the Airport Fuel Prices endpoints is strictly bound to the operator associated with the 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 updates.
  • 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 (for example, new passengers, updated lists, passenger‑document changes).

For more information on setting up and managing webhooks, see the Event Notifications (Webhook) Guide.

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.

For more information on managing crew qualifications, see the Crew Qualification Management Guide.

Note:

All crew‑qualification operations are bound to the operator context associated with the authentication token. Partners can manage qualifications only for crew members within their own organization.

Operations

Get crew qualifications

Request

Retrieves 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.

For more information on managing crew qualifications, see the Crew Qualification Management Guide.

Security
X-Api-Client-Id and X-Auth-Token
Query
filterstringrequired

Filter by crewId (required).

Required filters:

  • crewId with EQ operator (equal)
    • Example: crewId,EQ,12345
Example: filter=crewId,EQ,12345
limitinteger[ 10 .. 50 ]

Maximum number of records to return.

Default 10
Example: limit=20
offsetinteger>= 0

Number of records to skip before starting to return results.

Default 0
curl -i -X GET \
  'https://test.fl3xx.com/api/v2/external/crew-qualifications?filter=crewId%2CEQ%2C12345&limit=20&offset=0' \
  -H 'X-Api-Client-Id: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Successfully retrieved crew qualifications

Bodyapplication/json
dataArray of objects(CrewQualificationSimplifiedDto)

The list of crew qualifications for the current page.

paginationobject(Pagination)

Pagination details

Response
application/json
{
  "data": [
    { … }
  ],
  "pagination": {
    "offset": 0,
    "limit": 20,
    "totalItems": 150,
    "sortItems": [ … ],
    "filters": [ … ]
  }
}

Assign a qualification to a crew member

Request

Assigns 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.

For more information on managing crew qualifications, see the Crew Qualification Management Guide.

Security
X-Api-Client-Id and X-Auth-Token
Bodyapplication/jsonrequired
crewIdstringrequired

Unique identifier of the crew member

Example: "crew-67890"
qualificationTypeIdstringrequired

Unique identifier of the qualification type

Example: "qual-type-12345"
licenseNumberstring

License or certificate number

Example: "ATP-123456"
issuingAuthoritystring

Authority that issued the license or certificate

Example: "FAA"
countrystring

Country where the license was issued (ISO 3166-1 alpha-3)

Example: "AUT"
issueDatestring(date)

Date when the license was issued

Example: "2023-01-15"
expiryDatestring(date)

Date when the license expires

Example: "2025-01-15"
trainingStartDatestring(date)

Date when training for this qualification started

Example: "2022-12-01"
notesstring

Additional notes or comments about the qualification

Example: "Completed simulator training"
isPilotInCommandboolean

Whether this qualification allows pilot-in-command privileges

Example: true
baseMonthstring

Base month for qualification calculations

Enum"JANUARY""FEBRUARY""MARCH""APRIL""MAY""JUNE""JULY""AUGUST""SEPTEMBER""OCTOBER"
Example: "JANUARY"
curl -i -X POST \
  https://test.fl3xx.com/api/v2/external/crew-qualifications \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Client-Id: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "crewId": "crew-67890",
    "qualificationTypeId": "qual-type-12345",
    "licenseNumber": "ATP-123456",
    "issuingAuthority": "FAA",
    "country": "AUT",
    "issueDate": "2023-01-15",
    "expiryDate": "2025-01-15",
    "trainingStartDate": "2022-12-01",
    "notes": "Completed simulator training",
    "isPilotInCommand": true,
    "baseMonth": "JANUARY"
  }'

Responses

Successfully assigned qualification to crew member

Bodyapplication/json
idstring

Unique identifier for the crew qualification

Example: "qual-12345"
crewIdstring

Unique identifier of the crew member

Example: "crew-67890"
qualificationTypeIdstring

Unique identifier of the qualification type

Example: "qual-type-12345"
licenseNumberstring

License or certificate number

Example: "ATP-123456"
issuingAuthoritystring

Authority that issued the license or certificate

Example: "FAA"
countrystring

Country where the license was issued (ISO 3166-1 alpha-3)

Example: "AUT"
issueDatestring(date)

Date when the license was issued

Example: "2023-01-15"
expiryDatestring(date)

Date when the license expires

Example: "2025-01-15"
trainingStartDatestring(date)

Date when training for this qualification started

Example: "2022-12-01"
notesstring

Additional notes or comments about the qualification

Example: "Completed simulator training"
isPilotInCommandboolean

Whether this qualification allows pilot-in-command privileges

Example: true
baseMonthstring

Base month for qualification calculations

Enum"JANUARY""FEBRUARY""MARCH""APRIL""MAY""JUNE""JULY""AUGUST""SEPTEMBER""OCTOBER"
Example: "JANUARY"
createdAtDateTimestring(date-time)

Date and time when the qualification was created

Example: "2024-01-15T10:30:00.000Z"
updatedAtDateTimestring(date-time)

Date and time when the qualification was last updated

Example: "2024-01-15T10:30:00.000Z"
Response
application/json
{
  "id": "qual-12345",
  "crewId": "crew-67890",
  "qualificationTypeId": "qual-type-12345",
  "licenseNumber": "ATP-123456",
  "issuingAuthority": "FAA",
  "country": "AUT",
  "issueDate": "2023-01-15",
  "expiryDate": "2025-01-15",
  "trainingStartDate": "2022-12-01",
  "notes": "Completed simulator training",
  "isPilotInCommand": true,
  "baseMonth": "JANUARY",
  "createdAtDateTime": "2024-01-15T10:30:00.000Z",
  "updatedAtDateTime": "2024-01-15T10:30:00.000Z"
}

Get a crew qualification by ID

Request

Retrieves 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.

For more information on managing crew qualifications, see the Crew Qualification Management Guide.

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

The unique identifier of the crew qualification to retrieve

Example: qual-12345
curl -i -X GET \
  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 retrieved crew qualification

Bodyapplication/json
idstring

Unique identifier for the crew qualification

Example: "qual-12345"
crewIdstring

Unique identifier of the crew member

Example: "crew-67890"
qualificationTypeIdstring

Unique identifier of the qualification type

Example: "qual-type-12345"
licenseNumberstring

License or certificate number

Example: "ATP-123456"
issuingAuthoritystring

Authority that issued the license or certificate

Example: "FAA"
countrystring

Country where the license was issued (ISO 3166-1 alpha-3)

Example: "AUT"
issueDatestring(date)

Date when the license was issued

Example: "2023-01-15"
expiryDatestring(date)

Date when the license expires

Example: "2025-01-15"
trainingStartDatestring(date)

Date when training for this qualification started

Example: "2022-12-01"
notesstring

Additional notes or comments about the qualification

Example: "Completed simulator training"
isPilotInCommandboolean

Whether this qualification allows pilot-in-command privileges

Example: true
baseMonthstring

Base month for qualification calculations

Enum"JANUARY""FEBRUARY""MARCH""APRIL""MAY""JUNE""JULY""AUGUST""SEPTEMBER""OCTOBER"
Example: "JANUARY"
documentobject(BinaryDocumentDto)
createdAtDateTimestring(date-time)

Date and time when the qualification was created

Example: "2024-01-15T10:30:00.000Z"
updatedAtDateTimestring(date-time)

Date and time when the qualification was last updated

Example: "2024-01-15T10:30:00.000Z"
Response
application/json
{
  "id": "qual-12345",
  "crewId": "crew-67890",
  "qualificationTypeId": "qual-type-12345",
  "licenseNumber": "ATP-123456",
  "issuingAuthority": "FAA",
  "country": "AUT",
  "issueDate": "2023-01-15",
  "expiryDate": "2025-01-15",
  "trainingStartDate": "2022-12-01",
  "notes": "Completed simulator training",
  "isPilotInCommand": true,
  "baseMonth": "JANUARY",
  "document": {
    "id": 12345,
    "uuid": "doc-uuid-67890",
    "originalName": "pilot_license.pdf",
    "fileSize": 1024000,
    "createdAtDateTime": "2024-01-15T10:30:00.000Z",
    "customName": "Captain License",
    "imageSizeX": 1920,
    "imageSizeY": 1080,
    "isThumbnail": false
  },
  "createdAtDateTime": "2024-01-15T10:30:00.000Z",
  "updatedAtDateTime": "2024-01-15T10:30:00.000Z"
}

Flights

Access comprehensive flight information and data. These endpoints enable partners to retrieve flight details with advanced filtering and pagination.

Business Value

  • Retrieve flight data with flexible date‑range filtering.
  • 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 near‑real‑time.
  • Build flight‑tracking and reporting dashboards with paginated results.
Operations

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, including 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.
Operations