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

index.json

index.yaml

Overview

URL https://www.fl3xx.com

FL3XX Integration Support integrations@fl3xx.com

License MIT

Servers

Test 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

Booking Itinerary (Legs)

Operations related to flight itinerary legs.

Operations

Crew

Operations related to crew details.

Operations

Empty Legs

Operations related to empty leg flights.

Operations

Flights

Operations related to flights.

Operations

Flight Animals

Operations related flight animals.

Operations

Flight Cargo

Operations related to flight cargo.

Operations

Flight Crew

Operations related to crew for individual flights.

Operations

Flight Fixed Base Operator (FBO)

Operations related to FBO.

Operations

Flight Fuels

Operations related to fuel for flights.

Operations

Flight Ground Services

Operations related to ground services.

Operations

Flight Luggage

Operations related to luggage for flights.

Operations

Flight Migration

Operations related to migrations.

Operations

Flight Notifications

Operations related to notifications for flights.

Operations

Flight Passengers

Operations related to passenger for flights.

Operations

Add Passenger to Flight

Request

Adds a passenger to a specific flight using its flight ID.

Path

flightIdinteger(int64)required

Flight ID

Bodyapplication/jsonrequired

passenger

commentstring

externalReferencestring

internalIdinteger(int64)

isMainboolean

linksArray of objects(Link)

paxExternalReferencestring

paxIdCardIdinteger(int64)

paxTypestring

Enum"NONE""MALE""FEMALE""CHILD""INFANT""OTHER"

paxUserIdinteger(int64)

seatOnLapboolean

ticketIdinteger(int64)

curl -i -X POST \
  'https://test.fl3xx.com/api/external/flight/{flightId}/passenger' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "comment": "string",
    "externalReference": "string",
    "internalId": 0,
    "isMain": true,
    "links": [
      {
        "deprecation": "string",
        "href": "string",
        "hreflang": "string",
        "media": "string",
        "name": "string",
        "profile": "string",
        "rel": {},
        "title": "string",
        "type": "string"
      }
    ],
    "paxExternalReference": "string",
    "paxIdCardId": 0,
    "paxType": "NONE",
    "paxUserId": 0,
    "seatOnLap": true,
    "ticketId": 0
  }'

Responses

Success

Bodyapplication/json

commentstring

externalReferencestring

internalIdinteger(int64)

isMainboolean

linksobject(Links)

paxExternalReferencestring

paxIdCardIdinteger(int64)

paxTypestring

Enum"NONE""MALE""FEMALE""CHILD""INFANT""OTHER"

paxUserIdinteger(int64)

seatOnLapboolean

ticketIdinteger(int64)

Response

application/json

{
  "comment": "string",
  "externalReference": "string",
  "internalId": 0,
  "isMain": true,
  "links": {
    "empty": true
  },
  "paxExternalReference": "string",
  "paxIdCardId": 0,
  "paxType": "NONE",
  "paxUserId": 0,
  "seatOnLap": true,
  "ticketId": 0
}

Get a Flight Passenger

Request

Fetches the passenger details of a specific flight ticket using the flight ID and ticket ID.

Path

flightIdinteger(int64)required

Flight ID

ticketIdinteger(int64)required

ticketId

curl -i -X GET \
  'https://test.fl3xx.com/api/external/flight/{flightId}/passenger/{ticketId}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

commentstring

externalReferencestring

internalIdinteger(int64)

isMainboolean

linksobject(Links)

paxExternalReferencestring

paxIdCardIdinteger(int64)

paxTypestring

Enum"NONE""MALE""FEMALE""CHILD""INFANT""OTHER"

paxUserIdinteger(int64)

seatOnLapboolean

ticketIdinteger(int64)

Response

application/json

{
  "comment": "string",
  "externalReference": "string",
  "internalId": 0,
  "isMain": true,
  "links": {
    "empty": true
  },
  "paxExternalReference": "string",
  "paxIdCardId": 0,
  "paxType": "NONE",
  "paxUserId": 0,
  "seatOnLap": true,
  "ticketId": 0
}

Update a Flight Passenger

Request

Updates the passenger details of a specific flight ticket using the flight ID and ticket ID.

Path

flightIdinteger(int64)required

Flight ID

ticketIdinteger(int64)required

ticketId

Bodyapplication/json

passenger

commentstring

externalReferencestring

internalIdinteger(int64)

isMainboolean

linksArray of objects(Link)

paxExternalReferencestring

paxIdCardIdinteger(int64)

paxTypestring

Enum"NONE""MALE""FEMALE""CHILD""INFANT""OTHER"

paxUserIdinteger(int64)

seatOnLapboolean

ticketIdinteger(int64)

curl -i -X PUT \
  'https://test.fl3xx.com/api/external/flight/{flightId}/passenger/{ticketId}' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "comment": "string",
    "externalReference": "string",
    "internalId": 0,
    "isMain": true,
    "links": [
      {
        "deprecation": "string",
        "href": "string",
        "hreflang": "string",
        "media": "string",
        "name": "string",
        "profile": "string",
        "rel": {},
        "title": "string",
        "type": "string"
      }
    ],
    "paxExternalReference": "string",
    "paxIdCardId": 0,
    "paxType": "NONE",
    "paxUserId": 0,
    "seatOnLap": true,
    "ticketId": 0
  }'

Responses

Success

Bodyapplication/json

commentstring

externalReferencestring

internalIdinteger(int64)

isMainboolean

linksobject(Links)

paxExternalReferencestring

paxIdCardIdinteger(int64)

paxTypestring

Enum"NONE""MALE""FEMALE""CHILD""INFANT""OTHER"

paxUserIdinteger(int64)

seatOnLapboolean

ticketIdinteger(int64)

Response

application/json

{
  "comment": "string",
  "externalReference": "string",
  "internalId": 0,
  "isMain": true,
  "links": {
    "empty": true
  },
  "paxExternalReference": "string",
  "paxIdCardId": 0,
  "paxType": "NONE",
  "paxUserId": 0,
  "seatOnLap": true,
  "ticketId": 0
}

Remove a Flight Passenger

Request

Removes the passenger details of a specific flight ticket using the flight ID and ticket ID.

Path

flightIdinteger(int64)required

Flight ID

ticketIdinteger(int64)required

ticketId

curl -i -X DELETE \
  'https://test.fl3xx.com/api/external/flight/{flightId}/passenger/{ticketId}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

deletedboolean

Response

application/json

{
  "deleted": true
}

Get Flight Passengers

Request

Fetches a list of passengers assigned to a specific flight using its flight ID.

Path

flightIdinteger(int64)required

Flight ID

curl -i -X GET \
  'https://test.fl3xx.com/api/external/flight/{flightId}/passengers' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [

commentstring

externalReferencestring

internalIdinteger(int64)

isMainboolean

linksobject(Links)

paxExternalReferencestring

paxIdCardIdinteger(int64)

paxTypestring

Enum"NONE""MALE""FEMALE""CHILD""INFANT""OTHER"

paxUserIdinteger(int64)

seatOnLapboolean

ticketIdinteger(int64)

]

Response

application/json

[
  {
    "comment": "string",
    "externalReference": "string",
    "internalId": 0,
    "isMain": true,
    "links": { … },
    "paxExternalReference": "string",
    "paxIdCardId": 0,
    "paxType": "NONE",
    "paxUserId": 0,
    "seatOnLap": true,
    "ticketId": 0
  }
]

Flight PAX Details

Operations related to PAX details.

Operations

Flight Planning Notes

Operations related to planning notes for flights.

Operations

Flight Post Flight

Operations related to post-flight activities.

Operations

Flight Pre Flight

Operations related to pre-flight operations.

Operations

Flight Sanction List

Operations related to flight sanctions and approvals.

Operations

Flight Travel Authorization

Operations related to travel authorization.

Operations

Flight Tickets

Operations related to flight tickets.

Operations

Quotes

Operations related to flight quotes.

Operations

Roster

Operations related to Rosters.

Operations

Users

Operations related to Users.

Operations

FL3XX API (1.0.0)

Accounting

Accounts

Airports

Aircraft

Booking Itinerary (Legs)

Crew

Empty Legs

Flights

Flight Animals

Flight Cargo

Flight Crew

Flight Fixed Base Operator (FBO)

Flight Fuels

Flight Ground Services

Flight Luggage

Flight Migration

Flight Notifications

Flight Passengers

Add Passenger to Flight

RequestExpand all

Responses

Was this helpful?

Get a Flight Passenger

Request

Responses

Was this helpful?

Update a Flight Passenger

RequestExpand all

Responses

Was this helpful?

Remove a Flight Passenger

Request

Responses

Was this helpful?

Get Flight Passengers

Request

Responses

Was this helpful?

Flight PAX Details

Flight Planning Notes

Flight Post Flight

Flight Pre Flight

Flight Sanction List

Flight Travel Authorization

Flight Tickets

Quotes

Roster

Users

Request

Request