FL3XX API (1.0.0)

FL3XX API allows partners to access flight information, airport details, and a vast array of aviation services.

Download OpenAPI description
Overview
URL https://www.fl3xx.com
FL3XX Integration Support integrations@fl3xx.com
License MIT
Languages
Servers
Mock server
https://developer.fl3xx.com/_mock/reference/
Sandbox server
https://test.fl3xx.com/

Accounting

Operations related to accounting.

Operations

Accounts

Operations related accounts.

Operations

Airports

Access and manage airport information.

Operations

Aircraft

Operations related to aircraft.

Operations

Get Fleet

Request

Fetches aircraft/fleet.

Query
datestring

Earliest aircraft modification in format 'YYYY-MM-DDThh:mm‘

Example: date=2024-09-28T22:00
curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/aircraft?date=string' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
ambulanceboolean

Indicates whether the aircraft is an ambulance or not

Example: true
aocobject(AocDto)
cabinHeightnumber(float)

Cabin height

Example: 1.8
cabinLengthnumber(float)

Cabin length

Example: 10
cabinWidthnumber(float)

Cabin width

Example: 2
cargoboolean

Indicates whether the aircraft is a cargo aircraft or not

categorystring

Category

Enum"PISTON""TURBO_PROP""VERY_LIGHT_JET""LIGHT_JET""SUPER_LIGHT_JET""MIDSIZE_JET""SUPER_MIDSIZE_JET""HEAVY_JET""ULTRA_LONG_RANGE_JET""VIP_JET"
Example: "PISTON"
equipmentobject(AircraftEquipmentDto)
externalHeightnumber(float)

External height

Example: 3
externalLengthnumber(float)

External length

Example: 20
flightNumberTokenstring

Flight number token

homebasestring

Homebase

Example: "LMML"
idinteger(int64)

FL3XX Aircraft ID

keyAccountManagerobject(UserDto)
layoutobject(AircraftLayoutDto)
linksobject(Links)
maxFuelnumber(float)

Max fuel

Example: 1000
maxPayloadnumber(float)

Maximum payload

Example: 1000
maxRangenumber(float)

Maximum range

Example: 1000
minRunwaynumber(float)

Minimum runway

Example: 1000
modelstring

Model

Example: "Clipper"
normalCruiseSpeednumber(float)

Normal cruise speed

Example: 0.8
numberOfSeatsinteger(int32)

Number of seats

Example: 3
subcharterboolean

Indicates whether the aircraft is subcharter or not

Example: true
tailNumberstring

Tail number

Example: "SX-HIC"
typestring

Type

Example: "R44"
typeNamestring

Type name

Example: "Robi 44"
typeOfUsestring

Type of use

Enum"CHARTER""PRIVATE"
Example: "PRIVATE"
typeRatingstring

Type rating

wingSpannumber(float)

Wing span

Example: 0
]
Response
application/json
[ { "ambulance": true, "aoc": {}, "cabinHeight": 1.8, "cabinLength": 10, "cabinWidth": 2, "cargo": true, "category": "PISTON", "equipment": {}, "externalHeight": 3, "externalLength": 20, "flightNumberToken": "string", "homebase": "LMML", "id": 0, "keyAccountManager": {}, "layout": {}, "links": {}, "maxFuel": 1000, "maxPayload": 1000, "maxRange": 1000, "minRunway": 1000, "model": "Clipper", "normalCruiseSpeed": 0.8, "numberOfSeats": 3, "subcharter": true, "tailNumber": "SX-HIC", "type": "R44", "typeName": "Robi 44", "typeOfUse": "PRIVATE", "typeRating": "string", "wingSpan": 0 } ]

Get Aircraft Picture

Request

Fetches an aircraft picture using the document's uuid.

Path
uuidstring(uuid)required

picture uuid

curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/aircraft/picture/{uuid}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Body

Get Aircraft Thumbnail Picture

Request

Fetches a thumbnail (100x100 px) of an aircraft picture using the document's UUID.

Path
uuidstring(uuid)required

picture uuid

curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/aircraft/picture/{uuid}/thumbnail' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Body

Get an Aircraft

Request

Fetches details of an aircraft using its tail number.

Path
tailNumberstringrequired

Aircraft ID

Example: OE-FL3XX
curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/aircraft/{tailNumber}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
ambulanceboolean

Indicates whether the aircraft is an ambulance or not

Example: true
aocobject(AocDto)
cabinHeightnumber(float)

Cabin height

Example: 1.8
cabinLengthnumber(float)

Cabin length

Example: 10
cabinWidthnumber(float)

Cabin width

Example: 2
cargoboolean

Indicates whether the aircraft is a cargo aircraft or not

categorystring

Category

Enum"PISTON""TURBO_PROP""VERY_LIGHT_JET""LIGHT_JET""SUPER_LIGHT_JET""MIDSIZE_JET""SUPER_MIDSIZE_JET""HEAVY_JET""ULTRA_LONG_RANGE_JET""VIP_JET"
Example: "PISTON"
equipmentobject(AircraftEquipmentDto)
externalHeightnumber(float)

External height

Example: 3
externalLengthnumber(float)

External length

Example: 20
flightNumberTokenstring

Flight number token

homebasestring

Homebase

Example: "LMML"
idinteger(int64)

FL3XX Aircraft ID

keyAccountManagerobject(UserDto)
layoutobject(AircraftLayoutDto)
linksobject(Links)
maxFuelnumber(float)

Max fuel

Example: 1000
maxPayloadnumber(float)

Maximum payload

Example: 1000
maxRangenumber(float)

Maximum range

Example: 1000
minRunwaynumber(float)

Minimum runway

Example: 1000
modelstring

Model

Example: "Clipper"
normalCruiseSpeednumber(float)

Normal cruise speed

Example: 0.8
numberOfSeatsinteger(int32)

Number of seats

Example: 3
subcharterboolean

Indicates whether the aircraft is subcharter or not

Example: true
tailNumberstring

Tail number

Example: "SX-HIC"
typestring

Type

Example: "R44"
typeNamestring

Type name

Example: "Robi 44"
typeOfUsestring

Type of use

Enum"CHARTER""PRIVATE"
Example: "PRIVATE"
typeRatingstring

Type rating

wingSpannumber(float)

Wing span

Example: 0
Response
application/json
{ "ambulance": true, "aoc": { "id": 33453, "name": "string" }, "cabinHeight": 1.8, "cabinLength": 10, "cabinWidth": 2, "cargo": true, "category": "PISTON", "equipment": { "baggageVolume": 493, "cd_dvd": true, "coffeePot": false, "enclosedLavatory": false, "entertainmentSystem": true, "espresso": true, "golfBags": false, "headsets": true, "iceBin": true, "lavatory": true, "maxWeight": 2170, "microwaveOven": true, "petsAllowed": true, "satPhone": true, "satTV": false, "skiTube": false, "smokingAllowed": false, "standardSuitcases": 18, "tv": true, "v110": true, "v230": false, "warmingOven": true, "wifi": true }, "externalHeight": 3, "externalLength": 20, "flightNumberToken": "string", "homebase": "LMML", "id": 0, "keyAccountManager": { "internalId": 485949, "externalReference": "665321646", "firstName": "Luke", "lastName": "Joe", "gender": "MALE", "birthDate": "1988-03-18", "birthPlace": "Conroe", "acronym": "LJ", "birthCountry": "US", "account": {}, "address": {}, "email": "myemail@fl3xx.com", "documentExpiration": "2030-04-03", "documentExternalReference": 69905, "documentNumber": "CC4AA3390294NJ", "documentType": "PASSPORT", "issueCountry": "USA", "issueDate": "2020-04-02", "links": {}, "logName": "string", "mobile": 1111111111, "nationality": "US", "personnelNumber": 996659598, "phone": 11111111111, "radiationProtectionRegistryId": 1112221112221, "salutation": "Mr", "siflType": "CONTROL", "status": "ACTIVE", "weight": 80.5 }, "layout": { "cabinCrew": 0, "flightCrew": 0, "onboardEngineer": 0 }, "links": { "empty": true }, "maxFuel": 1000, "maxPayload": 1000, "maxRange": 1000, "minRunway": 1000, "model": "Clipper", "normalCruiseSpeed": 0.8, "numberOfSeats": 3, "subcharter": true, "tailNumber": "SX-HIC", "type": "R44", "typeName": "Robi 44", "typeOfUse": "PRIVATE", "typeRating": "string", "wingSpan": 0 }

Get Aircraft Hold Items

Request

Fetches hold items associated with an aircraft using its tail number.

Path
tailNumberstringrequired

tailNumber

Example: OE-FL3XX
Query
fromstring(date)YYYY-MM-DDrequired

from

tostring(date)YYYY-MM-DDrequired

to

dateSearchTypestring

dateSearchType

Default "ALL"
Enum"ALL""REPORT""DUE""CORRECTED"