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

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

Get Accounts

Request

Get list of accounts.

Query

limitinteger(int32)

Maximum number of items returned

Default 100

offsetinteger(int32)

Offset

Default 0

curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/user/account?limit=100&offset=0' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

The Account data

Bodyapplication/jsonArray [

accountNumberstring

Account number

Example: 1111

accountidinteger(int64)read-only

FL3XX generated account ID

Example: 1111

emailstring

Email address

Example: "email@fl3xx.com"

externalReferencestring

External reference

Example: "669665849-f120-4f65-6325-11111"

internalIdinteger(int64)read-only

Internal ID

Example: 632123

mobilestring

Mobile phone

Example: 111111111

namestring

Account name

Example: "Account"

notesstring

Notes

Example: "Notes"

phonestring

Phone number

Example: 111111111

vatNumberstring

VAT Number

Example: "A11111111111"

addressobject(AddressDto)

linksobject(Links)

]

Response

application/json

[
  {
    "accountNumber": 1111,
    "accountid": 1111,
    "email": "email@fl3xx.com",
    "externalReference": "669665849-f120-4f65-6325-11111",
    "internalId": 632123,
    "mobile": 111111111,
    "name": "Account",
    "notes": "Notes",
    "phone": 111111111,
    "vatNumber": "A11111111111",
    "address": { … },
    "links": { … }
  }
]

Creates an account

Request

Creates a new account

Bodyapplication/json

account

accountNumberstring

Account number

Example: 1111

emailstring

Email address

Example: "email@fl3xx.com"

externalReferencestring

External reference

Example: "669665849-f120-4f65-6325-11111"

mobilestring

Mobile phone

Example: 111111111

namestring

Account name

Example: "Account"

notesstring

Notes

Example: "Notes"

phonestring

Phone number

Example: 111111111

vatNumberstring

VAT Number

Example: "A11111111111"

addressobject(AddressDto)

linksobject(Links)

curl -i -X POST \
  https://developer.fl3xx.com/_mock/reference/api/external/user/account \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "accountNumber": 1111,
    "email": "email@fl3xx.com",
    "externalReference": "669665849-f120-4f65-6325-11111",
    "mobile": 111111111,
    "name": "Account",
    "notes": "Notes",
    "phone": 111111111,
    "vatNumber": "A11111111111",
    "address": {
      "buildingDetails": "14th",
      "city": "Lisbon",
      "country": "Portugal",
      "externalReference": "External ref",
      "latitude": 0.1,
      "links": {
        "empty": true
      },
      "longitude": 0.1,
      "recipient": "Recipient",
      "street": "My Street",
      "type": "WORK",
      "zip": 111111
    },
    "links": {
      "empty": true
    }
  }'

Responses

Newly created Account data

Bodyapplication/json

accountNumberstring

Account number

Example: 1111

accountidinteger(int64)read-only

FL3XX generated account ID

Example: 1111

emailstring

Email address

Example: "email@fl3xx.com"

externalReferencestring

External reference

Example: "669665849-f120-4f65-6325-11111"

internalIdinteger(int64)read-only

Internal ID

Example: 632123

mobilestring

Mobile phone

Example: 111111111

namestring

Account name

Example: "Account"

notesstring

Notes

Example: "Notes"

phonestring

Phone number

Example: 111111111

vatNumberstring

VAT Number

Example: "A11111111111"

addressobject(AddressDto)

linksobject(Links)

Response

application/json

{
  "accountNumber": 1111,
  "accountid": 1111,
  "email": "email@fl3xx.com",
  "externalReference": "669665849-f120-4f65-6325-11111",
  "internalId": 632123,
  "mobile": 111111111,
  "name": "Account",
  "notes": "Notes",
  "phone": 111111111,
  "vatNumber": "A11111111111",
  "address": {
    "buildingDetails": "14th",
    "city": "Lisbon",
    "country": "Portugal",
    "externalReference": "External ref",
    "internalId": 334455,
    "latitude": 0.1,
    "links": { … },
    "longitude": 0.1,
    "recipient": "Recipient",
    "street": "My Street",
    "type": "WORK",
    "zip": 111111
  },
  "links": {
    "empty": true
  }
}

Get an Account

Request

Fetches details of an account using it's externalReference

Path

externalReferencestringrequired

Property externalReference for the account

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

Responses

The Account data

Bodyapplication/json

accountNumberstring

Account number

Example: 1111

accountidinteger(int64)read-only

FL3XX generated account ID

Example: 1111

emailstring

Email address

Example: "email@fl3xx.com"

externalReferencestring

External reference

Example: "669665849-f120-4f65-6325-11111"

internalIdinteger(int64)read-only

Internal ID

Example: 632123

mobilestring

Mobile phone

Example: 111111111

namestring

Account name

Example: "Account"

notesstring

Notes

Example: "Notes"

phonestring

Phone number

Example: 111111111

vatNumberstring

VAT Number

Example: "A11111111111"

addressobject(AddressDto)

linksobject(Links)

Response

application/json

{
  "accountNumber": 1111,
  "accountid": 1111,
  "email": "email@fl3xx.com",
  "externalReference": "669665849-f120-4f65-6325-11111",
  "internalId": 632123,
  "mobile": 111111111,
  "name": "Account",
  "notes": "Notes",
  "phone": 111111111,
  "vatNumber": "A11111111111",
  "address": {
    "buildingDetails": "14th",
    "city": "Lisbon",
    "country": "Portugal",
    "externalReference": "External ref",
    "internalId": 334455,
    "latitude": 0.1,
    "links": { … },
    "longitude": 0.1,
    "recipient": "Recipient",
    "street": "My Street",
    "type": "WORK",
    "zip": 111111
  },
  "links": {
    "empty": true
  }
}

Update an account

Request

Updates an existing account using its externalReference

Path

externalReferencestringrequired

externalReference

Bodyapplication/json

account

accountNumberstring

Account number

Example: 1111

emailstring

Email address

Example: "email@fl3xx.com"

externalReferencestring

External reference

Example: "669665849-f120-4f65-6325-11111"

mobilestring

Mobile phone

Example: 111111111

namestring

Account name

Example: "Account"

notesstring

Notes

Example: "Notes"

phonestring

Phone number

Example: 111111111

vatNumberstring

VAT Number

Example: "A11111111111"

addressobject(AddressDto)

linksobject(Links)

curl -i -X PUT \
  'https://developer.fl3xx.com/_mock/reference/api/external/user/account/{externalReference}' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "accountNumber": 1111,
    "email": "email@fl3xx.com",
    "externalReference": "669665849-f120-4f65-6325-11111",
    "mobile": 111111111,
    "name": "Account",
    "notes": "Notes",
    "phone": 111111111,
    "vatNumber": "A11111111111",
    "address": {
      "buildingDetails": "14th",
      "city": "Lisbon",
      "country": "Portugal",
      "externalReference": "External ref",
      "latitude": 0.1,
      "links": {
        "empty": true
      },
      "longitude": 0.1,
      "recipient": "Recipient",
      "street": "My Street",
      "type": "WORK",
      "zip": 111111
    },
    "links": {
      "empty": true
    }
  }'

Responses

The updated Account data

Bodyapplication/json

accountNumberstring

Account number

Example: 1111

accountidinteger(int64)read-only

FL3XX generated account ID

Example: 1111

emailstring

Email address

Example: "email@fl3xx.com"

externalReferencestring

External reference

Example: "669665849-f120-4f65-6325-11111"

internalIdinteger(int64)read-only

Internal ID

Example: 632123

mobilestring

Mobile phone

Example: 111111111

namestring

Account name

Example: "Account"

notesstring

Notes

Example: "Notes"

phonestring

Phone number

Example: 111111111

vatNumberstring

VAT Number

Example: "A11111111111"

addressobject(AddressDto)

linksobject(Links)

Response

application/json

{
  "accountNumber": 1111,
  "accountid": 1111,
  "email": "email@fl3xx.com",
  "externalReference": "669665849-f120-4f65-6325-11111",
  "internalId": 632123,
  "mobile": 111111111,
  "name": "Account",
  "notes": "Notes",
  "phone": 111111111,
  "vatNumber": "A11111111111",
  "address": {
    "buildingDetails": "14th",
    "city": "Lisbon",
    "country": "Portugal",
    "externalReference": "External ref",
    "internalId": 334455,
    "latitude": 0.1,
    "links": { … },
    "longitude": 0.1,
    "recipient": "Recipient",
    "street": "My Street",
    "type": "WORK",
    "zip": 111111
  },
  "links": {
    "empty": true
  }
}

Delete an account

Request

Deletes (makes inactive) an existing account using its reference

Path

externalReferencestringrequired

externalReference

curl -i -X DELETE \
  'https://developer.fl3xx.com/_mock/reference/api/external/user/account/{externalReference}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

The updated Account data

Body

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

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

Get Accounts

Request

Responses

Was this helpful?

Creates an account

RequestExpand all

Responses

Was this helpful?

Get an Account

Request

Responses

Was this helpful?

Update an account

RequestExpand all

Responses

Was this helpful?

Delete an account

Request

Responses

Was this helpful?

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

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