Currently in active development with our trusted beta partners. Explore the next generation of aviation API capabilities.
BETA
Version: 2.4.0
License: MIT
## Servers
Test Server
```
https://test.fl3xx.com
```
## Security
### X-Api-Client-Id
Type: apiKey
In: header
Name: X-Api-Client-Id
### X-Auth-Token
Type: apiKey
In: header
Name: X-Auth-Token
## Download OpenAPI description
[FL3XX API](https://developer.fl3xx.com/_bundle/reference/@v2/index.yaml)
## Airports
Access comprehensive airport information.
**Business Value**
- Filter airports by various criteria, including ICAO, IATA, FAA codes, and local identifiers
- Support high‑performance applications with optimized data retrieval
**Use Cases**
- Filter airports by specific codes for targeted data retrieval
- Integrate airport data into flight‑planning and scheduling systems
- Build airport‑selection interfaces with efficient pagination
### Get airport
- [GET /api/v2/airports/{airportCode}](https://developer.fl3xx.com/reference/v2/airports/v2airportsget.md): This endpoint provides efficient access to airport data.
Features:
- Filter by multiple codes (ICAO, IATA, FAA, local identifier)
- Automatically exclude deleted or inactive airports
## Airport Fuel Prices
Manage and optimize airport‑fuel pricing data for your organization. These endpoints enable operators to efficiently update, remove, and bulk‑manage fuel prices, supporting streamlined fuel‑order workflows and provider management.
**Business Value**
- Ensure accurate, up‑to‑date fuel pricing for all airport operations.
- Reduce manual effort and errors by enabling bulk updates and deletions.
- Support cost control and negotiation with providers through transparent pricing data.
- Enhance operational planning and financial forecasting with reliable fuel‑cost data.
**Use Cases**
- Update fuel prices for a specific airport to reflect new agreements or market changes.
- Remove outdated or incorrect fuel prices for compliance and data integrity.
- Perform bulk deletions to quickly adapt to network‑wide pricing changes.
- Integrate with internal systems to automate fuel‑price management and reporting.
**Note:**
> Data managed by the Airport Fuel Prices endpoints is strictly bound to the operator associated with the authentication token. All operations — creating, updating, or deleting airport fuel prices — apply only to the operator for which the provided token is valid.
### Get fuel prices for an airport
- [GET /api/v2/partners/airports/{airportCode}/fuel-prices](https://developer.fl3xx.com/reference/v2/airport-fuel-prices/v2airportsfuelpricesget.md): Retrieves all fuel prices for a specific airport that were submitted by the partner associated with the authentication token.
Features:
- Returns all fuel prices submitted by the authenticated partner for the given airport
Note: This endpoint is for Partner Fuel Providers. Only fuel prices associated with the operator linked to the authentication token will be returned.
### Update fuel prices for an airport
- [PUT /api/v2/partners/airports/{airportCode}/fuel-prices](https://developer.fl3xx.com/reference/v2/airport-fuel-prices/v2airportsfuelpricesput.md): Update or set fuel prices for a specific airport. This endpoint allows partners to submit fuel pricing information that will be used for operational and financial processes.
Features:
- Replaces all partner-submitted fuel prices for the given airport
- Accepts 1 to 10 fuel price entries per request
Note: This endpoint is for Partner Fuel Providers. Only fuel prices associated with the operator linked to the authentication token can be updated.
### Delete all fuel prices for an airport
- [DELETE /api/v2/partners/airports/{airportCode}/fuel-prices](https://developer.fl3xx.com/reference/v2/airport-fuel-prices/v2airportsfuelpricesdelete.md): Delete all fuel prices for a specific airport that were submitted by the partner associated with the authentication token.
Features:
- Removes all partner-submitted fuel prices for the given airport in a single operation
Note: This endpoint is for Partner Fuel Providers. Only fuel prices associated with the operator linked to the authentication token can be deleted.
### Delete all fuel prices
- [DELETE /api/v2/partners/airport-fuel-prices](https://developer.fl3xx.com/reference/v2/airport-fuel-prices/v2airportsfuelpricesalldelete.md): Delete all fuel prices submitted by the partner associated with the authentication token across all airports.
Features:
- Removes all partner-submitted fuel prices across all airports in a single operation
Note: This endpoint is for Partner Fuel Providers. Only fuel prices associated with the operator linked to the authentication token can be deleted in bulk.
### Update individual fuel price
- [PUT /api/v2/partners/airport-fuel-prices/{fuelPriceId}](https://developer.fl3xx.com/reference/v2/airport-fuel-prices/v2airportsfuelpricesbyidput.md): Updates a specific fuel price by its ID. This endpoint allows partners to modify individual fuel pricing records.
Features:
- Updates a single fuel price record by its numeric ID
Note: This endpoint is for Partner Fuel Providers. Only fuel prices associated with the operator linked to the authentication token can be updated.
### Delete individual fuel price
- [DELETE /api/v2/partners/airport-fuel-prices/{fuelPriceId}](https://developer.fl3xx.com/reference/v2/airport-fuel-prices/v2airportsfuelpricesbyiddelete.md): Deletes a specific fuel price by its ID. This endpoint allows partners to remove individual fuel pricing records.
Features:
- Removes a single fuel price record by its numeric ID
Note: This endpoint is for Partner Fuel Providers. Only fuel prices associated with the operator linked to the authentication token can be deleted.
## Webhooks
Manage webhook subscriptions for near‑real‑time event notifications. These endpoints enable partners to create, manage, and monitor webhook subscriptions for receiving flight‑related events and updates.
**Business Value**
- Receive near‑real‑time notifications for flight events and updates.
- Automate integration workflows with external systems.
- Monitor flight operations and passenger changes in near‑real‑time.
- Reduce polling overhead by using event-driven architecture.
**Use Cases**
- Subscribe to flight updates to sync data with external booking systems.
- Monitor passenger‑count changes for catering and ground‑service coordination.
- Track aircraft changes for maintenance and operational planning.
- Receive notifications for flight cancellations and time updates.
**Group Event Types** (not subscribable; appear in webhook deliveries when multiple events occur in a short period):
- `FLIGHT_UPDATE`: Group event that combines multiple flight update events. Includes: `FLIGHT_CREATE`, `FLIGHT_CANCEL`, `FLIGHT_TIME_UPDATE`, `FLIGHT_AIRCRAFT_UPDATE`, `FLIGHT_AIRPORT_UPDATE`, `FLIGHT_POST_FLIGHT_STATUS`, `FLIGHT_MOVEMENT_UPDATE`, `FLIGHT_PERMIT_UPDATE`.
- `FLIGHT_PASSENGER_UPDATE`: Group event that combines passenger-related events. Includes: `FLIGHT_PAX_COUNT_UPDATE`, `FLIGHT_PAX_LIST_UPDATE`.
- `FLIGHT_PERMIT_UPDATE`: Group event that combines permit-related events. Includes: `FLIGHT_PERMIT_ASSIGNMENT`, `FLIGHT_PERMIT_UNASSIGNMENT`.
- `FLIGHT_SLOT_PPR_UPDATE`: Group event that combines slot/PPR-related events. Includes: `FLIGHT_SLOT_PPR_ASSIGNMENT`, `FLIGHT_SLOT_PPR_UNASSIGNMENT`.
- `FLIGHT_FBO_UPDATE`: Group event that combines FBO-related events. Includes: `FLIGHT_FBO_ASSIGNMENT`, `FLIGHT_FBO_UNASSIGNMENT`.
- `FLIGHT_TRANSPORT_UPDATE`: Group event that combines transport-related events. Includes: `FLIGHT_TRANSPORT_ASSIGNMENT`, `FLIGHT_TRANSPORT_UNASSIGNMENT`.
- `FLIGHT_HOTEL_UPDATE`: Group event that combines hotel-related events. Includes: `FLIGHT_HOTEL_ASSIGNMENT`, `FLIGHT_HOTEL_UNASSIGNMENT`.
- `FLIGHT_CATERING_UPDATE`: Group event that combines catering-related events. Includes: `FLIGHT_CATERING_ASSIGNMENT`, `FLIGHT_CATERING_UNASSIGNMENT`.
- `FLIGHT_CREW_UPDATE`: Group event that combines flight crew-related events. Includes: `FLIGHT_CREW_LIST_UPDATE`, `FLIGHT_CREW_ASSIGNMENT`, `FLIGHT_CREW_DOCUMENT_UPDATE`, `FLIGHT_CREW_ADDRESS_UPDATE`.
For more information on setting up and managing webhooks, see the [Event Notifications (Webhook) Guide](/guides/guides/event-notifications).
**Important:**
> Webhook endpoints must respond within 1 second with a `200` status code. To avoid timeouts, we strongly recommend handling webhook processing on a different task/thread and immediately returning the response to FL3XX.
### Get webhook subscriptions
- [GET /api/v2/webhooks/subscriptions](https://developer.fl3xx.com/reference/v2/webhooks/webhooksubscriptionsget.md): Retrieves all webhook subscriptions for the authenticated partner and operator.
Features:
- Returns active and inactive webhook subscriptions
- Filtered by partner and operator context
For more information on setting up and managing webhooks, see the Event Notifications (Webhook) Guide.
### Create a new webhook subscription
- [POST /api/v2/webhooks/subscriptions](https://developer.fl3xx.com/reference/v2/webhooks/webhooksubscriptionpost.md): Creates a new webhook subscription for receiving near‑real‑time event notifications.
Features:
- Validates the callback URL format; only HTTPS is supported
- Sets an automatic expiration date of 15 days for subscriptions
- Only one subscription per event type is allowed per partner/operator; returns 409 if a non-deleted subscription for the same event type already exists
For more information on setting up and managing webhooks, see the Event Notifications (Webhook) Guide.
### Get webhook subscription by ID
- [GET /api/v2/webhooks/subscriptions/{subscriptionId}](https://developer.fl3xx.com/reference/v2/webhooks/webhooksubscriptionbyidget.md): Retrieves a specific webhook subscription by its unique identifier.
Features:
- Returns detailed subscription information
For more information on setting up and managing webhooks, see the Event Notifications (Webhook) Guide.
### Update webhook subscription callback URL or status
- [PATCH /api/v2/webhooks/subscriptions/{subscriptionId}](https://developer.fl3xx.com/reference/v2/webhooks/webhooksubscriptionbyidpatch.md): Updates the callback URL and/or the status (active or inactive) for an existing webhook subscription.
Features:
- Validates the new callback URL format; only HTTPS is supported
- Updates the subscription status to active or inactive
For more information on setting up and managing webhooks, see the Event Notifications (Webhook) Guide.
### Delete a webhook subscription
- [DELETE /api/v2/webhooks/subscriptions/{subscriptionId}](https://developer.fl3xx.com/reference/v2/webhooks/webhooksubscriptionbyiddelete.md): Deletes a webhook subscription and stops receiving notifications for the associated event type.
Features:
- Immediately stops webhook deliveries
For more information on setting up and managing webhooks, see the Event Notifications (Webhook) Guide.
### Renew a webhook subscription
- [POST /api/v2/webhooks/subscriptions/{subscriptionId}/renewals](https://developer.fl3xx.com/reference/v2/webhooks/webhooksubscriptionrenewalpost.md): Renews an existing webhook subscription to extend its expiration date.
Features:
- Extends subscription expiration by 1 month from current expiration date.
- Subscriptions can only be renewed 5 days before expiration.
For more information on setting up and managing webhooks, see the Event Notifications (Webhook) Guide.
### Get webhook deliveries
- [GET /api/v2/webhooks/deliveries](https://developer.fl3xx.com/reference/v2/webhooks/webhookdeliveriesget.md): Retrieve paginated webhook delivery history for the authenticated partner and operator.
Note: Only failed deliveries are supported at this time.
Features:
- Returns paginated delivery history with filtering and sorting
- Supports filtering by completion date and status
- Default sorting by completion date (descending)
For more information on setting up and managing webhooks, see the Event Notifications (Webhook) Guide.
## Qualification Types
Retrieve qualification types that define the available certifications and licenses assignable to crew members. These endpoints provide access to the operator's qualification catalogue, enabling dynamic forms and validation when assigning or updating crew qualifications.
**Business Value**
- Ensure accurate qualification assignments by identifying the correct type and its configuration.
- Align integration behavior with the operator's specific qualification catalogue.
- Support dynamic qualification interfaces that only display relevant fields for the selected type.
**Use Cases**
- Retrieve the full list of available qualification types before assigning a qualification to a crew member.
- Inspect a specific qualification type to understand its requirements and metadata.
- Build dynamic forms that adapt based on the chosen qualification type.
### Get qualification types
- [GET /api/v2/qualification-types](https://developer.fl3xx.com/reference/v2/qualification-types/qualificationtypesget.md): Retrieves available qualification types and their details for use in crew qualification assignments.
Features:
- Returns paginated list of available qualifications
- Includes qualification metadata and configuration
For more information on managing crew qualifications, see the Crew Qualification Management Guide.
### Get qualification type by ID
- [GET /api/v2/qualification-types/{id}](https://developer.fl3xx.com/reference/v2/qualification-types/qualificationtypebyidget.md): Retrieves detailed information about a specific qualification type.
Features:
- Returns complete qualification configuration and metadata
- Includes validity periods, grace periods, and relation information
For more information on managing crew qualifications, see the Crew Qualification Management Guide.
## Crew Qualifications
Manage crew qualifications and certifications. These endpoints enable partners to assign, update, and manage crew‑member qualifications, including licenses, certifications, and associated documents.
**Business Value**
- Maintain accurate crew qualification records for compliance and safety.
- Streamline qualification assignment and management processes.
- Support document management for qualification certificates and licenses.
- Ensure crew members meet operational requirements and regulations.
**Use Cases**
- Assign new qualifications to crew members with license details and expiration dates.
- Update existing qualification information, including license numbers and issuing authorities.
- Upload and manage qualification documents, such as certificates and licenses.
- Retrieve qualification information for crew members and compliance reporting.
- Delete obsolete qualifications and associated documents.
For more information on managing crew qualifications, see the [Crew Qualification Management Guide](/guides/guides/crew-qualification).
**Note:**
> All crew‑qualification operations are bound to the operator context associated with the authentication token. Partners can manage qualifications only for crew members within their own organization.
### Get crew qualifications
- [GET /api/v2/crew-qualifications](https://developer.fl3xx.com/reference/v2/crew-qualifications/crewqualificationsget.md): Retrieves crew qualifications with pagination and filtering capabilities.
Features:
- Filter by crew ID (required)
- Paginated results
For more information on managing crew qualifications, see the Crew Qualification Management Guide.
### Assign a qualification to a crew member
- [POST /api/v2/crew-qualifications](https://developer.fl3xx.com/reference/v2/crew-qualifications/crewqualificationpost.md): Assigns a new qualification to a crew member with license details, expiration dates, and other relevant information.
Features:
- Validates required fields including crew ID and qualification ID
- Supports license numbers, issuing authorities, and country information
- Handles pilot-in-command designations and base month calculations
For more information on managing crew qualifications, see the Crew Qualification Management Guide.
### Get a crew qualification by ID
- [GET /api/v2/crew-qualifications/{crewQualificationId}](https://developer.fl3xx.com/reference/v2/crew-qualifications/crewqualificationbyidget.md): Retrieves detailed information about a specific crew qualification including associated documents.
Features:
- Returns complete qualification details including document references
- Includes creation and update timestamps
For more information on managing crew qualifications, see the Crew Qualification Management Guide.
### Update a crew qualification by ID
- [PATCH /api/v2/crew-qualifications/{crewQualificationId}](https://developer.fl3xx.com/reference/v2/crew-qualifications/crewqualificationbyidpatch.md): Updates an existing crew qualification with new information.
Features:
- Updates qualification details including license numbers and dates
- Supports partial updates of qualification information
For more information on managing crew qualifications, see the Crew Qualification Management Guide.
### Delete a crew qualification by ID
- [DELETE /api/v2/crew-qualifications/{crewQualificationId}](https://developer.fl3xx.com/reference/v2/crew-qualifications/crewqualificationbyiddelete.md): Deletes a crew qualification and removes it from the system.
Features:
- Permanently removes the qualification record
- Returns confirmation of deletion
For more information on managing crew qualifications, see the Crew Qualification Management Guide.
### Delete document associated with a crew qualification
- [DELETE /api/v2/crew-qualifications/{crewQualificationId}/documents/{uuid}](https://developer.fl3xx.com/reference/v2/crew-qualifications/crewqualificationdocumentdelete.md): Deletes a document associated with a crew qualification.
Features:
- Permanently removes the document file
- Returns confirmation of deletion
For more information on managing crew qualifications, see the Crew Qualification Management Guide.
### Get document associated with a crew qualification
- [GET /api/v2/crew-qualifications/{crewQualificationId}/documents/{uuid}](https://developer.fl3xx.com/reference/v2/crew-qualifications/crewqualificationdocumentget.md): Downloads a document associated with a crew qualification.
Features:
- Downloads the actual document file
- Validates document ownership and access permissions
For more information on managing crew qualifications, see the Crew Qualification Management Guide.
### Upload document associated with a crew qualification
- [POST /api/v2/crew-qualifications/{crewQualificationId}/documents](https://developer.fl3xx.com/reference/v2/crew-qualifications/crewqualificationdocumentpost.md): Uploads a document file to be associated with a crew qualification.
Features:
- Associates the document with the specific qualification
- Returns document metadata including UUID for future access
For more information on managing crew qualifications, see the Crew Qualification Management Guide.
## Roster Types
Retrieve roster (duty) types that define which fields and behaviors are available when creating or updating a roster assignment. These endpoints provide access to the operator's roster configuration, enabling dynamic UI and validation.
**Business Value**
- Ensure accurate roster data by identifying relevant fields for each duty type.
- Align integration behavior with the operator’s specific roster configuration.
- Support dynamic roster interfaces that only display fields enabled for the selected type.
- Streamline the roster management process by reducing validation errors.
**Use Cases**
- Retrieve the full list of available roster types and their hierarchical structure.
- Inspect a specific roster type to determine which features (e.g., aircraft, airports, FTL) are enabled.
- Build dynamic forms that adapt based on the chosen roster duty type.
### Get roster types
- [POST /api/v2/roster-types-search](https://developer.fl3xx.com/reference/v2/roster-types/rostertypessearch.md): Returns roster (duty) types with pagination. Each item is simplified; use GET /api/v2/roster-types/{id} for the full type including boolean flags.
Features:
- Filter by native/custom duty types
- Sort results by name
- Pagination support
### Get roster type
- [GET /api/v2/roster-types/{id}](https://developer.fl3xx.com/reference/v2/roster-types/rostertypebyidget.md): Retrieves full details for a roster type, including all boolean flags that control which fields are enabled for assignments of this type.
Features:
- Returns the complete flag set for a specific duty type
- Use before creating or updating a roster assignment to determine which fields apply
## Roster Assignment
Manage crew roster assignments, including creating, retrieving, updating, and deleting duties. These endpoints enable partners to synchronize crew schedules and manage operational duties with the same semantics as the FL3XX web interface.
**Business Value**
- Automate crew schedule management and updates in real‑time.
- Keep crew schedules perfectly synchronized with external systems.
- Support crew self‑service and scheduler workflows via API.
- Reduce manual data entry and errors in crew roster management.
**Use Cases**
- Create a new roster assignment (e.g., Off, Flight, Standby) for a crew member.
- Retrieve detailed information about a specific roster duty, including associated aircraft and airports.
- Update existing roster assignments to reflect changes in schedules or duty types.
- Search and filter roster assignments by crew member, type, or date range.
### Get roster assignments
- [POST /api/v2/rosters-search](https://developer.fl3xx.com/reference/v2/roster-assignment/rosterassignmentssearch.md): Returns a paginated list of roster assignments. Each item in the response is simplified; use GET /api/v2/rosters/{id} for full details.
### Create roster assignment
- [POST /api/v2/rosters](https://developer.fl3xx.com/reference/v2/roster-assignment/rosterassignmentcreate.md): Creates a new roster assignment for a crew member. This is equivalent to adding a duty or day in the FL3XX roster interface.
Example Use Case: An automated scheduling system creates a "Standby" duty for a crew member, providing the start and end times, and ensuring all required references are correctly resolved.
Duration constraints:
- startDateTime must be strictly before endDateTime
- Maximum duration is 31 days for all roster types
- Maximum duration is 2 days for roster types with isDutyTimeVisible enabled
Field validation rules:
- Fields that the roster type does not support (e.g. sending dutyShiftType when isSubtypeVisible is false) are rejected with 400 — they are not silently ignored
- When a roster type has isDutyTimeVisible enabled, the following fields become mandatory if their corresponding flag is set: dutyAirportCode (isLocationVisible), departureAirportCode (isDepartureAirportEnabled), arrivalAirportCode (isArrivalAirportEnabled), serviceAirportCode (isForAirportEnabled), aircraft.tailNumber (isAircraftEnabled)
Check the roster type's configuration using GET /api/v2/roster-types/{id} before creating an assignment.
### Get roster assignment
- [GET /api/v2/rosters/{id}](https://developer.fl3xx.com/reference/v2/roster-assignment/rosterassignmentbyidget.md): Retrieves the full details of a specific roster assignment.
Features:
- Returns complete assignment data including aircraft, airports, and logbook details
- Provides timing and status information
- Dynamic response structure based on the assignment's roster type
Example Use Case: A crew member's mobile app retrieves the full details of a "Flight" duty to display the assigned aircraft and the departure/arrival airports to the user.
Note: Sections such as aircraft, logbook, and ftl will be populated only if they are enabled for that specific duty type; otherwise, they will be null.
### Replace roster assignment
- [PUT /api/v2/rosters/{id}](https://developer.fl3xx.com/reference/v2/roster-assignment/rosterassignmentbyidput.md): Replaces an existing roster assignment. All optional fields not provided in the request body are cleared on the assignment.
startDateTime and endDateTime should always be provided for a semantically correct PUT. If omitted, the existing values are preserved (due to how the API handles absent fields), but this behaviour should not be relied upon — always supply them.
Example Use Case: A scheduler performs a full replacement of a duty record, providing all relevant fields in the request to ensure a clean, authoritative update.
Validation rules (same as create):
- startDateTime must be strictly before endDateTime
- Fields the roster type does not support are rejected with 400
- Mandatory fields (when isDutyTimeVisible is set) must be present
- Duration constraints apply: max 31 days; max 2 days when isDutyTimeVisible
- FTL interdependency rules apply (see FTL schema)
### Patch roster assignment
- [PATCH /api/v2/rosters/{id}](https://developer.fl3xx.com/reference/v2/roster-assignment/rosterassignmentbyidpatch.md): Partially updates an existing roster assignment. Only the fields provided in the request body are updated; fields not included remain unchanged.
Example Use Case: A scheduler updates only the end time of an existing duty without affecting any other fields.
Validation rules:
- If provided, startDateTime must be strictly before endDateTime
- Fields the roster type does not support are rejected with 400 — they are not silently ignored
- Mandatory field checks (for isDutyTimeVisible) are not enforced on PATCH — only on PUT and create
- Duration constraints apply to the resulting start/end: max 31 days; max 2 days when isDutyTimeVisible
- FTL interdependency rules apply if ftl is provided (see FTL schema)
### Delete a roster assignment
- [DELETE /api/v2/rosters/{id}](https://developer.fl3xx.com/reference/v2/roster-assignment/rosterassignmentbyiddelete.md): Permanently removes the roster assignment.
## Flights
Access comprehensive flight information and data. These endpoints enable partners to retrieve flight details with advanced filtering and pagination.
**Business Value**
- Retrieve flight data with flexible date‑range filtering.
- Support high‑performance applications with optimized data retrieval and pagination.
- Access essential flight information, including schedules, aircraft assignments, and passenger counts.
**Use Cases**
- Retrieve flights within a specific date range for operational planning.
- Integrate flight data into external systems for scheduling and logistics.
- Monitor flight schedules and aircraft assignments in near‑real‑time.
- Build flight‑tracking and reporting dashboards with paginated results.
### Get flights
- [GET /api/v2/flights](https://developer.fl3xx.com/reference/v2/flights/flightsget.md): Retrieves 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.
## Aircraft
Access comprehensive aircraft and fleet information. These endpoints enable partners to retrieve aircraft data, including status, specifications, and operational details.
**Business Value**
- Retrieve complete fleet information, including active and inactive aircraft.
- Support fleet management and operational planning with detailed aircraft data.
- Access aircraft specifications, including capacity, category, and home‑base information.
**Use Cases**
- Retrieve fleet data for operational planning and scheduling.
- Integrate aircraft information into external systems for maintenance and logistics.
- Monitor aircraft status and availability across the fleet.
- Build fleet‑management dashboards with paginated results.
### Get fleet data
- [GET /api/v2/aircraft](https://developer.fl3xx.com/reference/v2/aircraft/fleetget.md): Retrieves aircraft fleet data with pagination capabilities.
Features:
- Returns both active and inactive aircraft in the fleet
- Paginated results with configurable limit (0–50) and offset
- Default sorting by updated date and time (descending)
## Flight Permits
Retrieve flight permit information for takeoff, landing, and overflight permissions. These endpoints enable operators to access flight permit data within the context of the operator data.
**Business Value**
- Retrieve accurate flight permit records for compliance and regulatory requirements.
- Access permit information for operational planning and verification.
- Monitor permit statuses and details for flights.
**Use Cases**
- Retrieve permit information for flights to verify compliance status.
- Review permit details including status, dates, and associated documents.
- Access permit information for operational planning and audits.
### Get flight permits
- [GET /api/v2/flights/{flightId}/permits](https://developer.fl3xx.com/reference/v2/flight-permits/flightpermitsget.md): Retrieves all flight permits for a specific flight.
Features:
- Returns all permits associated with the flight
- Includes permit details, status, and document information
Note: This endpoint is for operators within the context of the operator data. For FL3XX Partner Providers, use the /partners endpoints instead.
Example Use Case: An operations manager needs to retrieve all permits for a flight to verify compliance and check permit statuses before departure.
### Get flight permit by ID
- [GET /api/v2/flight-permits/{flightPermitId}](https://developer.fl3xx.com/reference/v2/flight-permits/flightpermitsbyidget.md): Retrieves detailed information about a specific flight permit including associated documents.
Features:
- Returns complete permit details including document references
- Includes creation and update timestamps
Note: This endpoint is for operators within the context of the operator data. For FL3XX Partner Providers, use the /partners endpoints instead.
Example Use Case: An operations manager needs to review the complete details of a specific permit, including any uploaded documents, to verify compliance or prepare for audits.
## Flight Slots & PPRs
Retrieve flight slot and PPR (Prior Permission Required) information. These endpoints enable operators to access flight slot and PPR data within the context of the operator data.
**Business Value**
- Retrieve accurate flight slot and PPR records for compliance and operational requirements.
- Access slot and PPR information for operational planning and verification.
- Monitor slot and PPR statuses and details for flights.
**Use Cases**
- Retrieve slot and PPR information for flights to verify compliance status.
- Review slot and PPR details including status, approval dates, and associated documents.
- Access slot and PPR information for operational planning and audits.
### Get flight slots and PPRs
- [GET /api/v2/flights/{flightId}/slots-pprs](https://developer.fl3xx.com/reference/v2/flight-slots-and-pprs/slotsandpprsget.md): Retrieves all flight slots and PPRs for a specific flight.
Features:
- Returns all slots and PPRs associated with the flight
- Includes slot/PPR details, status, and document information
Note: This endpoint is for operators within the context of the operator data. For Trip Support Providers, use the /partners endpoints instead.
Example Use Case: An operations manager needs to retrieve all slots and PPRs for a flight to verify compliance and check statuses before departure.
### Get flight slot/PPR by ID
- [GET /api/v2/flight-slots-pprs/{slotPprId}](https://developer.fl3xx.com/reference/v2/flight-slots-and-pprs/slotpprbyidget.md): Retrieves detailed information about a specific flight slot or PPR including associated documents.
Features:
- Returns complete slot/PPR details including document references
- Includes creation and update timestamps
Note: This endpoint is for operators within the context of the operator data. For Trip Support Providers, use the /partners endpoints instead.
Example Use Case: An operations manager needs to review the complete details of a specific slot or PPR, including any uploaded documents, to verify compliance or prepare for audits.
## Flight Permits (Provider)
Manage flight permits for takeoff, landing, and overflight permissions. These endpoints enable Trip Support Providers to create, update, retrieve, and delete flight permits, as well as manage associated documents.
**Business Value**
- Maintain accurate flight permit records for compliance and regulatory requirements.
- Streamline permit management processes with automated workflows.
- Support document management for permit certificates and approvals.
- Ensure flights have the necessary permissions before operations.
**Use Cases**
- Create new flight permits for upcoming flights with permit details and expiration dates.
- Update existing permit information, including permit numbers, status, and dates.
- Retrieve permit information for flights to verify compliance status.
- Upload and manage permit documents, such as certificates and approvals.
- Delete obsolete permits that are no longer valid or relevant.
**Note:**
> All flight‑permit operations are bound to the operator context associated with the authentication token. Trip Support Providers can manage permits only for flights within their own organization.
### Get flight permits - partner scope
- [GET /api/v2/partners/flights/{flightId}/permits](https://developer.fl3xx.com/reference/v2/flight-permits-(provider)/partnerflightpermitsget.md): Retrieves all flight permits for a specific flight within the partner's scope.
Features:
- Returns only permits accessible to the authenticated partner
- Includes permit details, status, and document information
Note: This endpoint is for Trip Support Providers. Only permits associated with the operator linked to the authentication token will be returned.
Example Use Case: A trip support provider needs to retrieve all permits for a flight to verify compliance and check permit statuses before departure.
### Get flight permit by ID - partner scope
- [GET /api/v2/partners/flight-permits/{flightPermitId}](https://developer.fl3xx.com/reference/v2/flight-permits-(provider)/partnerflightpermitsbyidget.md): Retrieves detailed information about a specific flight permit within the partner's scope, including associated documents.
Features:
- Returns complete permit details including document references
- Includes creation and update timestamps
Note: This endpoint is for Trip Support Providers. Only permits associated with the operator linked to the authentication token can be retrieved.
Example Use Case: A trip support provider needs to review the complete details of a specific permit, including any uploaded documents, to verify compliance or prepare for audits.
### Update flight permit by ID - partner scope
- [PATCH /api/v2/partners/flight-permits/{flightPermitId}](https://developer.fl3xx.com/reference/v2/flight-permits-(provider)/partnerflightpermitspatch.md): Updates an existing flight permit with new information.
Features:
- Updates permit details including permit number, status, dates, and notes
- Supports partial updates of permit information
Note: This endpoint is for Trip Support Providers. Only permits associated with the operator linked to the authentication token can be updated.
Example Use Case: A trip support provider needs to update a permit after receiving a new permit number or when permit status changes.
### Delete flight permit by ID - partner scope
- [DELETE /api/v2/partners/flight-permits/{flightPermitId}](https://developer.fl3xx.com/reference/v2/flight-permits-(provider)/partnerflightpermitsdelete.md): Deletes a flight permit and removes it from the system.
Features:
- Permanently removes the permit record
- Returns confirmation of deletion
Note: This endpoint is for Trip Support Providers. Only permits associated with the operator linked to the authentication token can be deleted.
Example Use Case: A trip support provider needs to remove an obsolete permit that is no longer valid or relevant for a flight.
### Create flight permit - partner scope
- [POST /api/v2/partners/flight-permits](https://developer.fl3xx.com/reference/v2/flight-permits-(provider)/partnerflightpermitspost.md): Creates a new flight permit for a flight with permit details, status, and dates.
Features:
- Validates required fields including flight ID and permit type
- Supports permit number, status, dates, country, and airport information
- Handles takeoff, landing, and overflight permit types
Note: This endpoint is for Trip Support Providers. Only permits for flights associated with the operator linked to the authentication token can be created.
Example Use Case: A trip support provider needs to create a new landing permit for a flight after receiving approval from the destination country's aviation authority.
### Upload document associated with a flight permit - partner scope
- [POST /api/v2/partners/flight-permits/{flightPermitId}/documents](https://developer.fl3xx.com/reference/v2/flight-permits-(provider)/partnerflightpermitdocumentpost.md): Uploads a document file to be associated with a flight permit.
Features:
- Supports various document formats
- Associates the document with the specific permit
- Returns confirmation of upload
Supported File Types:
- Images: All image formats (JPEG, PNG, GIF, BMP, etc.) except SVG
- Documents: PDF, Microsoft Office (Word, Excel, PowerPoint: .doc, .docx, .xls, .xlsx, .ppt, .pptx), OpenDocument formats (.odt, .ods), Microsoft Word legacy (.doc)
- Other: Email messages (.eml), Apple Passbook (.pkpass)
File Size Limits:
- Maximum file size: 5 MB (5,242,880 bytes)
Note: This endpoint is for Trip Support Providers. Only permits associated with the operator linked to the authentication token can have documents uploaded. Each permit can have only one document associated with it.
Example Use Case: A trip support provider needs to upload a scanned copy of a permit certificate or approval document to maintain digital records for compliance and verification.
### Get document associated with a flight permit - partner scope
- [GET /api/v2/partners/flight-permits/{flightPermitId}/documents/{documentUuid}](https://developer.fl3xx.com/reference/v2/flight-permits-(provider)/partnerflightpermitdocumentget.md): Downloads a document associated with a flight permit.
Features:
- Downloads the actual document file
- Validates document ownership and access permissions
Note: This endpoint is for Trip Support Providers. Only documents for permits associated with the operator linked to the authentication token can be downloaded.
Example Use Case: A trip support provider needs to download a permit certificate or approval document for verification or compliance purposes.
### Delete document associated with a flight permit - partner scope
- [DELETE /api/v2/partners/flight-permits/{flightPermitId}/documents/{documentUuid}](https://developer.fl3xx.com/reference/v2/flight-permits-(provider)/deleteflightpermitdocumentforpartner.md): Deletes a document associated with a flight permit.
Features:
- Permanently removes the document file
- Returns confirmation of deletion
Note: This endpoint is for Trip Support Providers. Only documents for permits associated with the operator linked to the authentication token can be deleted.
Example Use Case: A trip support provider needs to remove an outdated or incorrect document that was previously uploaded for a permit.
## Flight Slots & PPRs (Provider)
Manage flight slots and PPRs (Prior Permission Required). These endpoints enable Trip Support Providers to update, retrieve, and manage flight slots and PPRs, as well as manage associated documents.
**Business Value**
- Maintain accurate flight slot and PPR records for compliance and operational requirements.
- Streamline slot and PPR management processes with automated workflows.
- Support document management for slot and PPR certificates and approvals.
- Ensure flights have the necessary slots and PPRs before operations.
**Use Cases**
- Update existing slot and PPR information, including permit numbers, status, and approval dates.
- Retrieve slot and PPR information for flights to verify compliance status.
- Upload and manage slot and PPR documents, such as certificates and approvals.
- Delete obsolete slot and PPR documents that are no longer valid or relevant.
**Note:**
> All flight slot and PPR operations are bound to the operator context associated with the authentication token. Trip Support Providers can manage slots and PPRs only for flights within their own organization.
### Get flight slots and PPRs - partner scope
- [GET /api/v2/partners/flights/{flightId}/slots-pprs](https://developer.fl3xx.com/reference/v2/flight-slots-and-pprs-(provider)/partnerslotsandpprsget.md): Retrieves all flight slots and PPRs for a specific flight within the partner's scope.
Features:
- Returns only slots and PPRs accessible to the authenticated partner
- Includes slot/PPR details, status, and document information
Note: This endpoint is for Trip Support Providers. Only slots and PPRs associated with the operator linked to the authentication token will be returned.
Example Use Case: A trip support provider needs to retrieve all slots and PPRs for a flight to verify compliance and check statuses before departure.
### Get flight slot/PPR by ID - partner scope
- [GET /api/v2/partners/flight-slots-pprs/{slotPprId}](https://developer.fl3xx.com/reference/v2/flight-slots-and-pprs-(provider)/partnerslotsandpprsbyidget.md): Retrieves detailed information about a specific flight slot or PPR within the partner's scope, including associated documents.
Features:
- Returns complete slot/PPR details including document references
- Includes creation and update timestamps
Note: This endpoint is for Trip Support Providers. Only slots and PPRs associated with the operator linked to the authentication token can be retrieved.
Example Use Case: A trip support provider needs to review the complete details of a specific slot or PPR, including any uploaded documents, to verify compliance or prepare for audits.
### Update flight slot/PPR by ID - partner scope
- [PATCH /api/v2/partners/flight-slots-pprs/{slotPprId}](https://developer.fl3xx.com/reference/v2/flight-slots-and-pprs-(provider)/partnerslotsandpprsbyidpatch.md): Updates an existing flight slot or PPR with new information.
Features:
- Updates slot/PPR details including permit number, status, approval date, and notes
- Supports partial updates of slot/PPR information
Note: This endpoint is for Trip Support Providers. Only slots and PPRs associated with the operator linked to the authentication token can be updated.
Example Use Case: A trip support provider needs to update a slot or PPR after receiving a new permit number or when status changes.
### Upload document associated with a flight slot/PPR - partner scope
- [POST /api/v2/partners/flight-slots-pprs/{slotPprId}/documents](https://developer.fl3xx.com/reference/v2/flight-slots-and-pprs-(provider)/partnerslotpprdocumentspost.md): Uploads a document file to be associated with a flight slot or PPR.
Features:
- Supports various document formats
- Associates the document with the specific slot/PPR
- Returns confirmation of upload
Supported File Types:
- Images: All image formats (JPEG, PNG, GIF, BMP, etc.) except SVG
- Documents: PDF, Microsoft Office (Word, Excel, PowerPoint: .doc, .docx, .xls, .xlsx, .ppt, .pptx), OpenDocument formats (.odt, .ods), Microsoft Word legacy (.doc)
- Other: Email messages (.eml), Apple Passbook (.pkpass)
File Size Limits:
- Maximum file size: 5 MB (5,242,880 bytes)
Note: This endpoint is for Trip Support Providers. Only slots and PPRs associated with the operator linked to the authentication token can have documents uploaded. Each slot/PPR can have only one document associated with it.
Example Use Case: A trip support provider needs to upload a scanned copy of a slot confirmation or PPR approval document to maintain digital records for compliance and verification.
### Get document associated with a flight slot/PPR - partner scope
- [GET /api/v2/partners/flight-slots-pprs/{slotPprId}/documents/{documentUuid}](https://developer.fl3xx.com/reference/v2/flight-slots-and-pprs-(provider)/partnerslotpprdocumentsget.md): Downloads a document associated with a flight slot or PPR.
Features:
- Downloads the actual document file
- Validates document ownership and access permissions
Note: This endpoint is for Trip Support Providers. Only documents for slots and PPRs associated with the operator linked to the authentication token can be downloaded.
Example Use Case: A trip support provider needs to download a slot confirmation or PPR approval document for verification or compliance purposes.
### Delete document associated with a flight slot/PPR - partner scope
- [DELETE /api/v2/partners/flight-slots-pprs/{slotPprId}/documents/{documentUuid}](https://developer.fl3xx.com/reference/v2/flight-slots-and-pprs-(provider)/partnerslotpprdocumentsdelete.md): Deletes a document associated with a flight slot or PPR.
Features:
- Permanently removes the document file
- Returns confirmation of deletion
Note: This endpoint is for Trip Support Providers. Only documents for slots and PPRs associated with the operator linked to the authentication token can be deleted.
Example Use Case: A trip support provider needs to remove an outdated or incorrect document that was previously uploaded for a slot or PPR.
## FBO (Provider)
Manage FBO (Fixed Base Operator) services. These endpoints enable Trip Support Providers to update and retrieve FBO service entries, as well as manage associated documents.
**Note:**
> FBO services are read-only for properties - only status and remarks can be updated. Creation and deletion are not allowed.
### Get FBO service for a flight - partner scope
- [GET /api/v2/partners/flights/{flightId}/fbo-services](https://developer.fl3xx.com/reference/v2/fbo-(provider)/partnerfboget.md): Retrieves the FBO (Fixed Base Operator) service information for a specific flight within the partner's scope.
Features:
- Returns FBO service details including status, remarks, and documents
- Includes creation and update timestamps
Note: This endpoint is for Trip Support Providers. Only FBO services associated with the operator linked to the authentication token will be returned.
Example Use Case: A trip support provider needs to retrieve FBO service information for a flight to verify service arrangements and check status.
### Get FBO service by ID - partner scope
- [GET /api/v2/partners/fbo-services/{serviceId}](https://developer.fl3xx.com/reference/v2/fbo-(provider)/partnerfbobyidget.md): Retrieves detailed information about a specific FBO service within the partner's scope, including associated documents.
Features:
- Returns complete FBO service details including document references
- Includes creation and update timestamps
Note: This endpoint is for Trip Support Providers. Only FBO services associated with the operator linked to the authentication token can be retrieved.
Example Use Case: A trip support provider needs to review the complete details of a specific FBO service, including any uploaded documents, to verify compliance or prepare for audits.
### Update FBO service by ID - partner scope
- [PATCH /api/v2/partners/fbo-services/{serviceId}](https://developer.fl3xx.com/reference/v2/fbo-(provider)/partnerfbopatch.md): Updates an existing FBO service with new information.
Features:
- Updates FBO service details including status and remarks
- Supports partial updates of FBO service information
Note: This endpoint is for Trip Support Providers. Only FBO services associated with the operator linked to the authentication token can be updated. FBO services are read-only for properties - creation and deletion are not allowed.
Example Use Case: A trip support provider needs to update an FBO service after receiving new status information or when remarks change.
### Upload document associated with an FBO service - partner scope
- [POST /api/v2/partners/fbo-services/{serviceId}/documents](https://developer.fl3xx.com/reference/v2/fbo-(provider)/partnerfbodocumentpost.md): Uploads a document file to be associated with an FBO service.
Features:
- Supports various document formats
- Associates the document with the specific FBO service
- Returns confirmation of upload
Supported File Types:
- Images: All image formats (JPEG, PNG, GIF, BMP, etc.) except SVG
- Documents: PDF, Microsoft Office (Word, Excel, PowerPoint: .doc, .docx, .xls, .xlsx, .ppt, .pptx), OpenDocument formats (.odt, .ods), Microsoft Word legacy (.doc)
- Other: Email messages (.eml), Apple Passbook (.pkpass)
File Size Limits:
- Maximum file size: 5 MB (5,242,880 bytes)
Note: This endpoint is for Trip Support Providers. Only FBO services associated with the operator linked to the authentication token can have documents uploaded.
Example Use Case: A trip support provider needs to upload a scanned copy of an FBO confirmation or approval document to maintain digital records for compliance and verification.
### Get document associated with an FBO service - partner scope
- [GET /api/v2/partners/fbo-services/{serviceId}/documents/{uuid}](https://developer.fl3xx.com/reference/v2/fbo-(provider)/partnerfbodocumentget.md): Downloads a document associated with an FBO service.
Features:
- Downloads the actual document file
- Validates document ownership and access permissions
Note: This endpoint is for Trip Support Providers. Only documents for FBO services associated with the operator linked to the authentication token can be downloaded.
Example Use Case: A trip support provider needs to download an FBO confirmation or approval document for verification or compliance purposes.
### Delete document associated with an FBO service - partner scope
- [DELETE /api/v2/partners/fbo-services/{serviceId}/documents/{uuid}](https://developer.fl3xx.com/reference/v2/fbo-(provider)/partnerfbodocumentdelete.md): Deletes a document associated with an FBO service.
Features:
- Permanently removes the document file
- Returns confirmation of deletion
Note: This endpoint is for Trip Support Providers. Only documents for FBO services associated with the operator linked to the authentication token can be deleted.
Example Use Case: A trip support provider needs to remove an outdated or incorrect document that was previously uploaded for an FBO service.
## Transport (Provider)
Manage transport services. These endpoints enable Trip Support Providers to create, update, retrieve, and delete transport service entries, as well as manage associated documents.
**Note:**
> Transport services can be created if the partner is assigned to the flight. Deletion is only allowed if the transport service was created by the partner.
### Get transport services for a flight - partner scope
- [GET /api/v2/partners/flights/{flightId}/transport-services](https://developer.fl3xx.com/reference/v2/transport-(provider)/partnertransportsget.md): Retrieves all transport services for a specific flight within the partner's scope.
Features:
- Returns only transport services accessible to the authenticated partner
- Includes transport service details, status, type, person, and document information
Note: This endpoint is for Trip Support Providers. Only transport services associated with the operator linked to the authentication token will be returned.
Example Use Case: A trip support provider needs to retrieve all transport services for a flight to verify service arrangements and check statuses.
### Get transport service by ID - partner scope
- [GET /api/v2/partners/transport-services/{serviceId}](https://developer.fl3xx.com/reference/v2/transport-(provider)/partnertransportbyidget.md): Retrieves detailed information about a specific transport service within the partner's scope, including associated documents.
Features:
- Returns complete transport service details including document references
- Includes creation and update timestamps
Note: This endpoint is for Trip Support Providers. Only transport services associated with the operator linked to the authentication token can be retrieved.
Example Use Case: A trip support provider needs to review the complete details of a specific transport service, including any uploaded documents, to verify compliance or prepare for audits.
### Update transport service by ID - partner scope
- [PATCH /api/v2/partners/transport-services/{serviceId}](https://developer.fl3xx.com/reference/v2/transport-(provider)/partnertransportpatch.md): Updates an existing transport service with new information.
Features:
- Updates transport service details including status, type, person, and notes
- Supports partial updates of transport service information
Note: This endpoint is for Trip Support Providers. Only transport services associated with the operator linked to the authentication token can be updated.
Example Use Case: A trip support provider needs to update a transport service after receiving new status information or when service details change.
### Delete transport service by ID - partner scope
- [DELETE /api/v2/partners/transport-services/{serviceId}](https://developer.fl3xx.com/reference/v2/transport-(provider)/partnertransportdelete.md): Deletes a transport service and removes it from the system.
Features:
- Permanently removes the transport service record
- Returns confirmation of deletion
- Only allowed if the transport service was created by the partner (check "by" field)
Note: This endpoint is for Trip Support Providers. Only transport services associated with the operator linked to the authentication token and created by the partner can be deleted.
Example Use Case: A trip support provider needs to remove a transport service entry that was created in error or is no longer needed.
### Create transport service - partner scope
- [POST /api/v2/partners/transport-services](https://developer.fl3xx.com/reference/v2/transport-(provider)/partnertransportpost.md): Creates a new transport service for a flight with transport details, status, type, person, and notes.
Features:
- Validates required fields including flight ID
- Supports transport type, status, person assignment, and notes
- Handles various transport types (Limousine, CarRental, Taxi, GroundTransportation)
Note: This endpoint is for Trip Support Providers. Only transport services for flights associated with the operator linked to the authentication token and where the partner is assigned can be created.
Example Use Case: A trip support provider needs to create a new transport service for a flight after arranging transportation for passengers or crew.
### Upload document associated with a transport service - partner scope
- [POST /api/v2/partners/transport-services/{serviceId}/documents](https://developer.fl3xx.com/reference/v2/transport-(provider)/partnertransportdocumentpost.md): Uploads a document file to be associated with a transport service.
Features:
- Supports various document formats
- Associates the document with the specific transport service
- Returns confirmation of upload
Supported File Types:
- Images: All image formats (JPEG, PNG, GIF, BMP, etc.) except SVG
- Documents: PDF, Microsoft Office (Word, Excel, PowerPoint: .doc, .docx, .xls, .xlsx, .ppt, .pptx), OpenDocument formats (.odt, .ods), Microsoft Word legacy (.doc)
- Other: Email messages (.eml), Apple Passbook (.pkpass)
File Size Limits:
- Maximum file size: 5 MB (5,242,880 bytes)
Note: This endpoint is for Trip Support Providers. Only transport services associated with the operator linked to the authentication token can have documents uploaded.
Example Use Case: A trip support provider needs to upload a scanned copy of a transport confirmation or approval document to maintain digital records for compliance and verification.
### Get document associated with a transport service - partner scope
- [GET /api/v2/partners/transport-services/{serviceId}/documents/{documentUuid}](https://developer.fl3xx.com/reference/v2/transport-(provider)/partnertransportdocumentget.md): Downloads a document associated with a transport service.
Features:
- Downloads the actual document file
- Validates document ownership and access permissions
Note: This endpoint is for Trip Support Providers. Only documents for transport services associated with the operator linked to the authentication token can be downloaded.
Example Use Case: A trip support provider needs to download a transport confirmation or approval document for verification or compliance purposes.
### Delete document associated with a transport service - partner scope
- [DELETE /api/v2/partners/transport-services/{serviceId}/documents/{documentUuid}](https://developer.fl3xx.com/reference/v2/transport-(provider)/partnertransportdocumentdelete.md): Deletes a document associated with a transport service.
Features:
- Permanently removes the document file
- Returns confirmation of deletion
Note: This endpoint is for Trip Support Providers. Only documents for transport services associated with the operator linked to the authentication token can be deleted.
Example Use Case: A trip support provider needs to remove an outdated or incorrect document that was previously uploaded for a transport service.
### Get document associated with a hotel service - partner scope
- [GET /api/v2/partners/hotel-services/{serviceId}/documents/{documentUuid}](https://developer.fl3xx.com/reference/v2/transport-(provider)/partnerhoteldocumentget.md): Downloads a document associated with a hotel service.
Features:
- Downloads the actual document file
- Validates document ownership and access permissions
Note: This endpoint is for Trip Support Providers. Only documents for hotel services associated with the operator linked to the authentication token can be downloaded.
Example Use Case: A trip support provider needs to download a hotel confirmation or approval document for verification or compliance purposes.
### Delete document associated with a hotel service - partner scope
- [DELETE /api/v2/partners/hotel-services/{serviceId}/documents/{documentUuid}](https://developer.fl3xx.com/reference/v2/transport-(provider)/partnerhoteldocumentdelete.md): Deletes a document associated with a hotel service.
Features:
- Permanently removes the document file
- Returns confirmation of deletion
Note: This endpoint is for Trip Support Providers. Only documents for hotel services associated with the operator linked to the authentication token can be deleted.
Example Use Case: A trip support provider needs to remove an outdated or incorrect document that was previously uploaded for a hotel service.
## Hotel (Provider)
Manage hotel services. These endpoints enable Trip Support Providers to create, update, retrieve, and delete hotel service entries, as well as manage associated documents.
**Note:**
> Hotel services can be created if the partner is assigned to the flight. Deletion is only allowed if the hotel service was created by the partner.
### Get hotel services for a flight - partner scope
- [GET /api/v2/partners/flights/{flightId}/hotel-services](https://developer.fl3xx.com/reference/v2/hotel-(provider)/partnerhotelsget.md): Retrieves all hotel services for a specific flight within the partner's scope.
Features:
- Returns only hotel services accessible to the authenticated partner
- Includes hotel service details, status, service for, and document information
Note: This endpoint is for Trip Support Providers. Only hotel services associated with the operator linked to the authentication token will be returned.
Example Use Case: A trip support provider needs to retrieve all hotel services for a flight to verify service arrangements and check statuses.
### Get hotel service by ID - partner scope
- [GET /api/v2/partners/hotel-services/{serviceId}](https://developer.fl3xx.com/reference/v2/hotel-(provider)/partnerhotelbyidget.md): Retrieves detailed information about a specific hotel service within the partner's scope, including associated documents.
Features:
- Returns complete hotel service details including document references
- Includes creation and update timestamps
Note: This endpoint is for Trip Support Providers. Only hotel services associated with the operator linked to the authentication token can be retrieved.
Example Use Case: A trip support provider needs to review the complete details of a specific hotel service, including any uploaded documents, to verify compliance or prepare for audits.
### Update hotel service by ID - partner scope
- [PATCH /api/v2/partners/hotel-services/{serviceId}](https://developer.fl3xx.com/reference/v2/hotel-(provider)/partnerhotelpatch.md): Updates an existing hotel service with new information.
Features:
- Updates hotel service details including status, service for, and notes
- Supports partial updates of hotel service information
Note: This endpoint is for Trip Support Providers. Only hotel services associated with the operator linked to the authentication token can be updated.
Example Use Case: A trip support provider needs to update a hotel service after receiving new status information or when service details change.
### Delete hotel service by ID - partner scope
- [DELETE /api/v2/partners/hotel-services/{serviceId}](https://developer.fl3xx.com/reference/v2/hotel-(provider)/partnerhoteldelete.md): Deletes a hotel service and removes it from the system.
Features:
- Permanently removes the hotel service record
- Returns confirmation of deletion
- Only allowed if the hotel service was created by the partner (check "by" field)
Note: This endpoint is for Trip Support Providers. Only hotel services associated with the operator linked to the authentication token and created by the partner can be deleted.
Example Use Case: A trip support provider needs to remove a hotel service entry that was created in error or is no longer needed.
### Create hotel service - partner scope
- [POST /api/v2/partners/hotel-services](https://developer.fl3xx.com/reference/v2/hotel-(provider)/partnerhotelpost.md): Creates a new hotel service for a flight with hotel details, status, service for, and notes.
Features:
- Validates required fields including flight ID
- Supports service for (PAX, CREW, etc.), status, and notes
- Handles hotel service assignments
Note: This endpoint is for Trip Support Providers. Only hotel services for flights associated with the operator linked to the authentication token and where the partner is assigned can be created.
Example Use Case: A trip support provider needs to create a new hotel service for a flight after arranging hotel accommodations for passengers or crew.
### Upload document associated with a hotel service - partner scope
- [POST /api/v2/partners/hotel-services/{serviceId}/documents](https://developer.fl3xx.com/reference/v2/hotel-(provider)/partnerhoteldocumentpost.md): Uploads a document file to be associated with a hotel service.
Features:
- Supports various document formats
- Associates the document with the specific hotel service
- Returns confirmation of upload
Supported File Types:
- Images: All image formats (JPEG, PNG, GIF, BMP, etc.) except SVG
- Documents: PDF, Microsoft Office (Word, Excel, PowerPoint: .doc, .docx, .xls, .xlsx, .ppt, .pptx), OpenDocument formats (.odt, .ods), Microsoft Word legacy (.doc)
- Other: Email messages (.eml), Apple Passbook (.pkpass)
File Size Limits:
- Maximum file size: 5 MB (5,242,880 bytes)
Note: This endpoint is for Trip Support Providers. Only hotel services associated with the operator linked to the authentication token can have documents uploaded.
Example Use Case: A trip support provider needs to upload a scanned copy of a hotel confirmation or approval document to maintain digital records for compliance and verification.
## Catering (Provider)
Manage catering services. These endpoints enable Trip Support Providers to create, update, retrieve, and delete catering service entries, as well as manage associated documents.
**Note:**
> Catering services can be created if the partner is assigned to the flight. Deletion is only allowed if the catering service was created by the partner.
### Get catering services for a flight - partner scope
- [GET /api/v2/partners/flights/{flightId}/catering-services](https://developer.fl3xx.com/reference/v2/catering-(provider)/partnercateringget.md): Retrieves all catering services for a specific flight within the partner's scope.
Features:
- Returns only catering services accessible to the authenticated partner
- Includes catering service details, status, service for, order, pax, and document information
Note: This endpoint is for Trip Support Providers. Only catering services associated with the operator linked to the authentication token will be returned.
Example Use Case: A trip support provider needs to retrieve all catering services for a flight to verify service arrangements and check statuses.
### Get catering service by ID - partner scope
- [GET /api/v2/partners/catering-services/{serviceId}](https://developer.fl3xx.com/reference/v2/catering-(provider)/partnercateringbyidget.md): Retrieves detailed information about a specific catering service within the partner's scope, including associated documents.
Features:
- Returns complete catering service details including document references
- Includes creation and update timestamps
Note: This endpoint is for Trip Support Providers. Only catering services associated with the operator linked to the authentication token can be retrieved.
Example Use Case: A trip support provider needs to review the complete details of a specific catering service, including any uploaded documents, to verify compliance or prepare for audits.
### Update catering service by ID - partner scope
- [PATCH /api/v2/partners/catering-services/{serviceId}](https://developer.fl3xx.com/reference/v2/catering-(provider)/partnercateringpatch.md): Updates an existing catering service with new information.
Features:
- Updates catering service details including status, service for, order, and pax
- Supports partial updates of catering service information
Note: This endpoint is for Trip Support Providers. Only catering services associated with the operator linked to the authentication token can be updated.
Example Use Case: A trip support provider needs to update a catering service after receiving new status information or when service details change.
### Delete catering service by ID - partner scope
- [DELETE /api/v2/partners/catering-services/{serviceId}](https://developer.fl3xx.com/reference/v2/catering-(provider)/partnercateringdelete.md): Deletes a catering service and removes it from the system.
Features:
- Permanently removes the catering service record
- Returns confirmation of deletion
- Only allowed if the catering service was created by the partner (check "by" field)
Note: This endpoint is for Trip Support Providers. Only catering services associated with the operator linked to the authentication token and created by the partner can be deleted.
Example Use Case: A trip support provider needs to remove a catering service entry that was created in error or is no longer needed.
### Create catering service - partner scope
- [POST /api/v2/partners/catering-services](https://developer.fl3xx.com/reference/v2/catering-(provider)/partnercateringpost.md): Creates a new catering service for a flight with catering details, status, service for, order, and pax.
Features:
- Validates required fields including flight ID
- Supports service for (PAX, CREW, etc.), status, order, and pax count
- Handles catering service assignments
Note: This endpoint is for Trip Support Providers. Only catering services for flights associated with the operator linked to the authentication token and where the partner is assigned can be created.
Example Use Case: A trip support provider needs to create a new catering service for a flight after arranging catering for passengers or crew.
### Upload document associated with a catering service - partner scope
- [POST /api/v2/partners/catering-services/{serviceId}/documents](https://developer.fl3xx.com/reference/v2/catering-(provider)/partnercateringdocumentpost.md): Uploads a document file to be associated with a catering service.
Features:
- Supports various document formats
- Associates the document with the specific catering service
- Returns confirmation of upload
Supported File Types:
- Images: All image formats (JPEG, PNG, GIF, BMP, etc.) except SVG
- Documents: PDF, Microsoft Office (Word, Excel, PowerPoint: .doc, .docx, .xls, .xlsx, .ppt, .pptx), OpenDocument formats (.odt, .ods), Microsoft Word legacy (.doc)
- Other: Email messages (.eml), Apple Passbook (.pkpass)
File Size Limits:
- Maximum file size: 5 MB (5,242,880 bytes)
Note: This endpoint is for Trip Support Providers. Only catering services associated with the operator linked to the authentication token can have documents uploaded.
Example Use Case: A trip support provider needs to upload a scanned copy of a catering confirmation or approval document to maintain digital records for compliance and verification.
### Get document associated with a catering service - partner scope
- [GET /api/v2/partners/catering-services/{serviceId}/documents/{uuid}](https://developer.fl3xx.com/reference/v2/catering-(provider)/partnercateringdocumentget.md): Downloads a document associated with a catering service.
Features:
- Downloads the actual document file
- Validates document ownership and access permissions
Note: This endpoint is for Trip Support Providers. Only documents for catering services associated with the operator linked to the authentication token can be downloaded.
Example Use Case: A trip support provider needs to download a catering confirmation or approval document for verification or compliance purposes.
### Delete document associated with a catering service - partner scope
- [DELETE /api/v2/partners/catering-services/{serviceId}/documents/{uuid}](https://developer.fl3xx.com/reference/v2/catering-(provider)/partnercateringdocumentdelete.md): Deletes a document associated with a catering service.
Features:
- Permanently removes the document file
- Returns confirmation of deletion
Note: This endpoint is for Trip Support Providers. Only documents for catering services associated with the operator linked to the authentication token can be deleted.
Example Use Case: A trip support provider needs to remove an outdated or incorrect document that was previously uploaded for a catering service.