DocsChangelog1.7k
APIFlight

List flights

Deprecated

GET
/flight/list

Deprecated: This endpoint will be removed in the next major AirTrail release. Migrate to GET /api/v1/flights. List flights visible to the authenticated API key. scope=mine requires flight.read.own. scope=user and scope=all require flight.read.any.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Go to Settings -> Security and create a new API key. Use the generated key as the bearer token.

Query Parameters

scope?string

Which flights to return. mine is the default. user and all require flight.read.any.

Default"mine"
Value in"mine""user""all"
userId?string

The user ID whose flights should be returned when scope=user.

Response Body

A list of flights

application/json
  1. response
flights?array<>
Example Request
curl -X GET 'https://your-instance.com/api/flight/list'
Example Response
{  "flights": [    {      "id": 0,      "from": {        "id": 0,        "icao": "string",        "iata": "string",        "name": "string",        "lat": 0.1,        "lon": 0.1,        "type": "large_airport",        "continent": "string",        "country": "string",        "tz": "string"      },      "to": {        "id": 0,        "icao": "string",        "iata": "string",        "name": "string",        "lat": 0.1,        "lon": 0.1,        "type": "large_airport",        "continent": "string",        "country": "string",        "tz": "string"      },      "departure": "string",      "arrival": "string",      "date": "string",      "datePrecision": "day",      "passengers": [        {          "id": 0,          "flightId": 0,          "userId": "string",          "guestName": "string",          "seat": "aisle",          "seatNumber": "string",          "seatClass": "economy",          "flightReason": "leisure"        }      ],      "airline": "string",      "flightNumber": "string",      "aircraft": "string",      "aircraftReg": "string",      "note": "string"    }  ]}

Delete an access role DELETE

Previous Page

Export flights GET

**Deprecated:** This endpoint will be removed in the next major AirTrail release. Migrate to `GET /api/v1/flights/export`. Export an AirTrail backup visible to the authenticated API key. The JSON response matches the AirTrail import format. `scope=mine` requires `flight.export.own`. `scope=user` and `scope=all` require `flight.export.any`.