# Get flights

Retrieve flights with pagination and filtering capabilities. This endpoint provides access to simplified flight information including schedules, aircraft assignments, airports, and passenger counts.

Features:
- Filter by estimated blocks-off date and time range (required) using the BTW (between) operator
- Paginated results with configurable limit (10-50) and offset
- Default sorting by estimated blocks-off date and time (descending)
- Returns flight data including arrival and departure airport details, quote information, and workflow type

Response Data:
- Flight identification (ID, flight number, tail number)
- Quote information (quote ID, external reference, identifier)
- Time estimates (blocks-off and blocks-on estimated times)
- Airport details (arrival and departure airports with ICAO, IATA, FAA codes)
- Passenger and trip information
- Customer and account identifiers
- Workflow type and custom workflow name

Example Use Case: An operations manager needs to retrieve all flights scheduled between two dates to plan crew assignments and resource allocation. The endpoint returns paginated results with complete airport information for both departure and arrival locations.

Endpoint: GET /api/v2/flights
Version: 2.4.0
Security: X-Api-Client-Id, X-Auth-Token

## Query parameters:

  - `filter` (string, required)
    Filter by blocksOffEstimatedDateTime (required).

Required filters:
- blocksOffEstimatedDateTime with BTW operator (between)
  - Date format: YYYY-MM-DDTHH:mm:ss.SSSZ
  - Date values must be url encoded. Example: the following value blocksOffEstimatedDateTime,BTW,2025-01-01T00:00:00.000Z,2025-01-31T23:59:59.999Z would be encoded and sent as blocksOffEstimatedDateTime%2CBTW%2C2025-01-01T00%3A00%3A00.000Z%2C2025-01-31T23%3A59%3A59.999Z.
    Example: "blocksOffEstimatedDateTime%2CBTW%2C2025-01-01T00%3A00%3A00.000Z%2C2025-01-31T23%3A59%3A59.999Z"

  - `limit` (integer)
    Maximum number of records to return.
    Example: 20

  - `offset` (integer)
    Number of records to skip before starting to return results.

  - `sort` (string)
    Sort criteria in the format: field direction

Supported sort fields:
- blocksOffEstimatedDateTime (default: desc)
    Example: "blocksOffEstimatedDateTime,desc"

## Response 200 fields (application/json):

  - `data` (array)
    The list of flights for the current page.

  - `data.id` (string)
    Unique identifier for the flight
    Example: "12345"

  - `data.flightNumber` (string)
    Flight number
    Example: "FL123"

  - `data.tailNumber` (string)
    Aircraft tail number or registration
    Example: "N123AB"

  - `data.quoteId` (string)
    Unique identifier of the associated quote
    Example: "quote-67890"

  - `data.quoteExternalReference` (string)
    External reference for the quote
    Example: "EXT-REF-123"

  - `data.quoteIdentifier` (string)
    Quote identifier
    Example: "Q-2025-001"

  - `data.blocksOffEstimated` (string)
    Estimated blocks-off date and time (UTC)
    Example: "2025-01-15T10:30:00.000Z"

  - `data.blocksOnEstimated` (string)
    Estimated blocks-on date and time (UTC)
    Example: "2025-01-15T14:45:00.000Z"

  - `data.tripNumber` (integer)
    Trip number for this flight
    Example: 1

  - `data.paxNumber` (integer)
    Number of passengers on the flight
    Example: 8

  - `data.arrivalAirport` (object)

  - `data.arrivalAirport.id` (string)
    Unique identifier for the airport
    Example: "123"

  - `data.arrivalAirport.name` (string)
    Full name of the airport
    Example: "Vienna International Airport"

  - `data.arrivalAirport.icao` (string)
    ICAO code of the airport
    Example: "LOWW"

  - `data.arrivalAirport.iata` (string)
    IATA code of the airport
    Example: "VIE"

  - `data.arrivalAirport.faa` (string)
    FAA code of the airport (US airports only)
    Example: "KJFK"

  - `data.arrivalAirport.localIdentifier` (string)
    Local identifier code for the airport
    Example: "ABC"

  - `data.arrivalAirport.aid` (string)
    Airport AID (Airport Identifier) code
    Example: "AID123"

  - `data.departureAirport` (object)

  - `data.customerId` (string)
    Unique identifier of the customer
    Example: "customer-123"

  - `data.accountId` (string)
    Unique identifier of the account
    Example: "account-456"

  - `data.workflow` (string)
    Workflow type for the flight. This indicates the nature or type of the flight operation.
    Enum: "COMMERCIAL", "MAINTENANCE", "PRIVATE", "TRAINING", "OWNER", "INTERNAL", "RESERVED", "CHARTER", "SUBCHARTER", "SCHEDULED", "AMBULANCE", "CUSTOM1", "CUSTOM2", "CUSTOM3", "CUSTOM4", "CUSTOM5", "CUSTOM6", "BROKER", "BROKER_SUBCHARTER"

  - `data.workflowCustomName` (string)
    Custom name for the workflow
    Example: "Charter Flight"

  - `pagination` (object)
    Pagination details

  - `pagination.offset` (integer)
    Number of records skipped

  - `pagination.limit` (integer)
    Maximum number of records returned
    Example: 20

  - `pagination.totalItems` (integer)
    Total number of items available
    Example: 150

  - `pagination.sortItems` (array)
    List of fields used for sorting
    Example: ["issueDate desc"]

  - `pagination.filters` (array)
    List of applied filters

  - `pagination.filters.field` (string)
    Field name to filter by
    Example: "issueDate"

  - `pagination.filters.operator` (string)
    Filter operator
    Example: "gte"

  - `pagination.filters.value` (string)
    Filter value
    Example: "2024-01-01T00:00:00.000Z"


## Response 400 fields

## Response 401 fields

## Response 403 fields