Skip to content

Brex: Travel schemas

59 Brex schemas with complete fields and constraints.

← Travel operations · All schemas

Get booking — response body

FieldTypePresenceDescription and constraints
$objectRootA booking representation.
booking_dataModelRequired within parentExpand Get booking — response body — booking data
booking_referenceJSONOptional
booking_reference (anyOf 1)stringAlternativeThe booking reference number shown in the dashboard and used when contacting Brex Support. This is the reference from the travel provider, not the Brex internal booking ID. May be null if the booking has no associated reference.
booking_reference (anyOf 2)nullAlternative
created_atstringRequired within parentThe time when the booking was created.
Format: date-time
custom_fieldsJSONOptional
custom_fields (anyOf 1)arrayAlternativeCustom field values associated with this resource.
custom_fields (anyOf 1)[]ModelEach itemExpand Get trip — response body — custom fields Custom field values associated with this resource item
custom_fields (anyOf 2)nullAlternative
idstringRequired within parentThe ID of the booking.
policyJSONOptional
policy (anyOf 1)JSONAlternativeThe result of evaluating the customer's travel policy against this booking, as shown to the traveler when the booking was made. Mirrors the policy information available in the booking export. May be null when no policy was evaluated for the booking.
policy (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — policy out of policy, violations out of policy, violations
policy (anyOf 2)nullAlternative
sourcestringRequired within parentThe original source of a booking:
* `BREX_TRAVEL` - The booking was created via Brex Travel.
* `EXTERNAL` - The booking was manually inserted, e.g. a hotel room block for a group event.
Known values: BREX_TRAVEL, EXTERNAL
statusModelRequired within parentExpand Get booking — response body — status
trip_idstringRequired within parentThe ID of the trip to which this booking belongs.
trip_referenceJSONOptional
trip_reference (anyOf 1)stringAlternativeThe trip reference number shown in the dashboard and used when contacting Brex Support. This is the reference from the travel provider, not the Brex internal trip ID. May be null if the trip has no associated reference.
trip_reference (anyOf 2)nullAlternative
typestringRequired within parentThe type of a booking.
Known values: AIR, CAR_RENTAL, LODGING, RAIL
updated_atstringRequired within parentThe time when the booking was last updated.
Format: date-time
versionJSONRequired within parent
version (anyOf 1)integerAlternativeThe current version of the booking.
Format: int32
Minimum: 1
version (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get booking — response body — booking data, Get booking — response body — policy out of policy, violations out of policy, violations, Get booking — response body — status, Get trip — response body — custom fields Custom field values associated with this resource item

Get booking — response body — booking data

FieldTypePresenceDescription and constraints
$objectRootType-specific booking data.
discriminator: {"mapping": {"AIR": "#/components/schemas/travel__AirBookingData", "CAR_RENTAL": "#/components/schemas/travel__CarRentalBookingData", "LODGING": "#/components/schemas/travel__LodgingBookingData", "RAIL": "#/components/schemas/travel__RailBookingData"}, "propertyName": "type"}
$ (anyOf 1)ModelAlternativeExpand Get booking — response body — booking data Air-specific booking information
$ (anyOf 2)ModelAlternativeExpand Get booking — response body — booking data Car rental-specific booking information
$ (anyOf 3)ModelAlternativeExpand Get booking — response body — booking data Lodging-specific booking information
$ (anyOf 4)ModelAlternativeExpand Get booking — response body — booking data Rail-specific booking information

Referenced models: Get booking — response body — booking data Air-specific booking information, Get booking — response body — booking data Car rental-specific booking information, Get booking — response body — booking data Lodging-specific booking information, Get booking — response body — booking data Rail-specific booking information

Get booking — response body — booking data Air-specific booking information

FieldTypePresenceDescription and constraints
$objectRootAir-specific booking information.
journeysarrayRequired within parentThe journeys that make up this booking.
journeys[]ModelEach itemExpand Get booking — response body — booking data Air-specific booking information journeys item
known_traveler_numberJSONOptional
known_traveler_number (anyOf 1)JSONAlternative
known_traveler_number (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Air-specific booking information known traveler number document number, issuing country document number, issuing country
known_traveler_number (anyOf 1) (allOf 2)JSONAll variants applyThe Known Traveler Number associated with this booking.
known_traveler_number (anyOf 2)nullAlternative
redress_numberJSONOptional
redress_number (anyOf 1)JSONAlternative
redress_number (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Air-specific booking information known traveler number document number, issuing country document number, issuing country
redress_number (anyOf 1) (allOf 2)JSONAll variants applyThe Redress Number associated with this booking.
redress_number (anyOf 2)nullAlternative
ticketsarrayRequired within parentThe flight tickets in this booking.
tickets[]ModelEach itemExpand Get booking — response body — booking data Air-specific booking information tickets item
typestringOptional

Referenced models: Get booking — response body — booking data Air-specific booking information known traveler number document number, issuing country document number, issuing country, Get booking — response body — booking data Air-specific booking information tickets item, Get booking — response body — booking data Air-specific booking information journeys item

Get booking — response body — booking data Air-specific booking information journeys item

FieldTypePresenceDescription and constraints
$objectRootA journey is composed of one or more flight segments that take a passenger from an origin to a final destination. E.g. if a traveler is doing a round trip from GIG to SFO, but they need to make a connection in IAH in each direction, the booking will contain 2 journeys. The first will contain 2 segments: GIG > IAH, and IAH > SFO. The second journey will also contain 2 segments: SFO > IAH, and IAH > GIG.
cabin_display_nameJSONOptional
cabin_display_name (anyOf 1)stringAlternativeThe cabin name as shown by the airline.
cabin_display_name (anyOf 2)nullAlternative
flightsarrayRequired within parentThe flights that make up this journey.
flights[]ModelEach itemExpand Get booking — response body — booking data Air-specific booking information journeys item flights item
statusJSONRequired within parent
status (allOf 1)ModelAll variants applyExpand Get booking — response body — status
status (allOf 2)JSONAll variants applyThe status of this specific journey.

Referenced models: Get booking — response body — booking data Air-specific booking information journeys item flights item, Get booking — response body — status

Get booking — response body — booking data Air-specific booking information journeys item flights item

FieldTypePresenceDescription and constraints
$objectRootA flight taken by the traveler.
arrival_timeJSONRequired within parent
arrival_time (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp
arrival_time (allOf 2)JSONAll variants applyThe time when the flight arrives at the destination.
cabin_classJSONOptional
cabin_class (anyOf 1)JSONAlternative
cabin_class (anyOf 1) (allOf 1)stringAll variants applyThe cabin class of a flight.
Known values: ECONOMY, PREMIUM_ECONOMY, BUSINESS, FIRST
cabin_class (anyOf 1) (allOf 2)JSONAll variants applyThe cabin class for this flight.
cabin_class (anyOf 2)nullAlternative
confirmation_codeJSONOptional
confirmation_code (anyOf 1)stringAlternativeThe airline confirmation code.
confirmation_code (anyOf 2)nullAlternative
departure_timeJSONRequired within parent
departure_time (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp
departure_time (allOf 2)JSONAll variants applyThe time when the flight departs the origin.
destinationModelRequired within parentExpand Get booking — response body — booking data Air-specific booking information journeys item flights item origin
durationJSONOptional
duration (anyOf 1)stringAlternativeThe duration of the flight in the ISO 8601 PnYnMnDTnHnMnS format.
duration (anyOf 2)nullAlternative
marketing_flightJSONOptional
marketing_flight (anyOf 1)JSONAlternative
marketing_flight (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Air-specific booking information journeys item flights item marketing flight airline code, airline name, number The flight number, including carrier information
marketing_flight (anyOf 1) (allOf 2)JSONAll variants applyThe marketing flight number. Some flights are sold by one airline, but operated by another in the same alliance. This is the flight that was originally sold.
marketing_flight (anyOf 2)nullAlternative
operating_flightJSONOptional
operating_flight (anyOf 1)JSONAlternative
operating_flight (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Air-specific booking information journeys item flights item marketing flight airline code, airline name, number The flight number, including carrier information
operating_flight (anyOf 1) (allOf 2)JSONAll variants applyThe operating flight number. Some flights are sold by one airline, but operated by another in the same alliance. This is the flight the traveler is actually taking.
operating_flight (anyOf 2)nullAlternative
originModelRequired within parentExpand Get booking — response body — booking data Air-specific booking information journeys item flights item origin
seatJSONOptional
seat (anyOf 1)JSONAlternative
seat (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Air-specific booking information journeys item flights item seat The seat reserved for this flight Seat information in a flight
seat (anyOf 1) (allOf 2)JSONAll variants applyThe seat reserved for this flight.
seat (anyOf 2)nullAlternative

Referenced models: Get booking — response body — booking data Air-specific booking information journeys item flights item origin, Get booking — response body — booking data Air-specific booking information journeys item flights item marketing flight airline code, airline name, number The flight number, including carrier information, Get booking — response body — booking data Air-specific booking information journeys item flights item seat The seat reserved for this flight Seat information in a flight, Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp

Get booking — response body — booking data Air-specific booking information journeys item flights item marketing flight airline code, airline name, number The flight number, including carrier information

FieldTypePresenceDescription and constraints
$objectRootThe flight number, including carrier information.
airline_codestringRequired within parentThe IATA code for the airline.
Pattern: [0-9A-Z]{2}
airline_nameJSONOptional
airline_name (anyOf 1)stringAlternativeThe name of the airline.
airline_name (anyOf 2)nullAlternative
numberstringRequired within parentThe number of the flight.
Pattern: \d{1,4}

Get booking — response body — booking data Air-specific booking information journeys item flights item origin

FieldTypePresenceDescription and constraints
$objectRootThe place where a flight departs from or arrives at.
airport_codestringRequired within parentThe 3-letter IATA code of the airport.
Pattern: [A-Z]{3}
airport_locationJSONOptional
airport_location (anyOf 1)JSONAlternative
airport_location (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone
airport_location (anyOf 1) (allOf 2)JSONAll variants applyThe location of the airport.
airport_location (anyOf 2)nullAlternative
gateJSONOptional
gate (anyOf 1)stringAlternativeThe gate for boarding or leaving the plane.
gate (anyOf 2)nullAlternative
terminalJSONOptional
terminal (anyOf 1)stringAlternativeThe terminal name and/or number.
terminal (anyOf 2)nullAlternative

Referenced models: Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone

Get booking — response body — booking data Air-specific booking information journeys item flights item seat The seat reserved for this flight Seat information in a flight

FieldTypePresenceDescription and constraints
$objectRootSeat information in a flight.
numberstringRequired within parentThe seat number.
statusJSONOptional
status (anyOf 1)JSONAlternative
status (anyOf 1) (allOf 1)stringAll variants applyThe status of a flight seat.
Known values: PENDING, CONFIRMED, CANCELED
status (anyOf 1) (allOf 2)JSONAll variants apply
status (anyOf 2)nullAlternative

Get booking — response body — booking data Air-specific booking information known traveler number document number, issuing country document number, issuing country

FieldTypePresenceDescription and constraints
$objectRootA document number such as a redress number or a known traveler number.
document_numberstringRequired within parentThe actual document number.
issuing_countrystringRequired within parentThe country that issued this document.

Get booking — response body — booking data Air-specific booking information tickets item

FieldTypePresenceDescription and constraints
$objectRootA flight ticket.
issue_dateJSONOptional
issue_date (anyOf 1)stringAlternativeThe date when the ticket was issued.
Format: date
issue_date (anyOf 2)nullAlternative
numberstringRequired within parentThe ticket number provided by the airline.

Get booking — response body — booking data Car rental-specific booking information

FieldTypePresenceDescription and constraints
$objectRootCar rental-specific booking information.
car_detailsModelRequired within parentExpand Get booking — response body — booking data Car rental-specific booking information car details
reservation_detailsModelRequired within parentExpand Get booking — response body — booking data Car rental-specific booking information reservation details
typestringOptional

Referenced models: Get booking — response body — booking data Car rental-specific booking information car details, Get booking — response body — booking data Car rental-specific booking information reservation details

Get booking — response body — booking data Car rental-specific booking information car details

FieldTypePresenceDescription and constraints
$objectRootInformation on a rental car.
car_classJSONOptional
car_class (anyOf 1)JSONAlternative
car_class (anyOf 1) (allOf 1)stringAll variants applyThe kind of car.
Known values: ECONOMY, COMPACT, INTERMEDIATE, PREMIUM, LUXURY, CONVERTIBLE, COMPACT_SUV, INTERMEDIATE_SUV, PREMIUM_SUV, LUXURY_SUV, MINI_VAN, PASSENGER_VAN, PICKUP_TRUCK, HYBRID, ELECTRIC, MINI, STANDARD, FULL_SIZE, SUV, SPORTS, SPECIAL, RECREATIONAL_VEHICLE, OTHER
car_class (anyOf 1) (allOf 2)JSONAll variants apply
car_class (anyOf 2)nullAlternative
display_namestringRequired within parentThe name of the car as displayed to the user.

Get booking — response body — booking data Car rental-specific booking information reservation details

FieldTypePresenceDescription and constraints
$objectRootInformation on a car reservation such as pickup, drop-off, etc.
confirmation_codeJSONOptional
confirmation_code (anyOf 1)stringAlternativeThe confirmation code given by the vendor.
confirmation_code (anyOf 2)nullAlternative
drop_offJSONRequired within parent
drop_off (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Car rental-specific booking information reservation details pickup Information about the car pickup or drop-off
drop_off (allOf 2)JSONAll variants applyInformation on the car return.
pickupJSONRequired within parent
pickup (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Car rental-specific booking information reservation details pickup Information about the car pickup or drop-off
pickup (allOf 2)JSONAll variants applyInformation on the car pickup.
rental_companyJSONOptional
rental_company (anyOf 1)stringAlternativeName of car rental company.
rental_company (anyOf 2)nullAlternative

Referenced models: Get booking — response body — booking data Car rental-specific booking information reservation details pickup Information about the car pickup or drop-off

Get booking — response body — booking data Car rental-specific booking information reservation details pickup Information about the car pickup or drop-off

FieldTypePresenceDescription and constraints
$objectRootInformation about the car pickup or drop-off.
locationJSONRequired within parent
location (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone
location (allOf 2)JSONAll variants applyThe location where the car can be picked up or where it must be returned.
timeJSONRequired within parent
time (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp
time (allOf 2)JSONAll variants applyThe time when the car will be available for pickup or by when it must be returned.

Referenced models: Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone, Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp

Get booking — response body — booking data Lodging-specific booking information

FieldTypePresenceDescription and constraints
$objectRootLodging-specific booking information.
lodging_detailsModelRequired within parentExpand Get booking — response body — booking data Lodging-specific booking information lodging details
reservation_detailsModelRequired within parentExpand Get booking — response body — booking data Lodging-specific booking information reservation details
typestringOptional

Referenced models: Get booking — response body — booking data Lodging-specific booking information lodging details, Get booking — response body — booking data Lodging-specific booking information reservation details

Get booking — response body — booking data Lodging-specific booking information lodging details

FieldTypePresenceDescription and constraints
$objectRootInformation on a lodging venue.
brand_nameJSONOptional
brand_name (anyOf 1)stringAlternativeThe brand name of the hotel.
brand_name (anyOf 2)nullAlternative
chain_nameJSONOptional
chain_name (anyOf 1)stringAlternativeThe name of the hotel chain.
chain_name (anyOf 2)nullAlternative
contact_informationJSONOptional
contact_information (anyOf 1)JSONAlternative
contact_information (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information lodging details contact information Contact information of a venue Contact information of a venue
contact_information (anyOf 1) (allOf 2)JSONAll variants apply
contact_information (anyOf 2)nullAlternative
display_namestringRequired within parentThe name of the venue as displayed to the user.
locationJSONOptional
location (anyOf 1)JSONAlternative
location (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone
location (anyOf 1) (allOf 2)JSONAll variants applyThe location of the hotel.
location (anyOf 2)nullAlternative
star_ratingJSONOptional
star_rating (anyOf 1)JSONAlternative
star_rating (anyOf 1) (anyOf 1)numberAlternativeThe star rating of the hotel. Some hotels have half stars.
Format: float
star_rating (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
star_rating (anyOf 2)nullAlternative

Referenced models: Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone, Get booking — response body — booking data Lodging-specific booking information lodging details contact information Contact information of a venue Contact information of a venue

Get booking — response body — booking data Lodging-specific booking information lodging details contact information Contact information of a venue Contact information of a venue

FieldTypePresenceDescription and constraints
$objectRootContact information of a venue.
emailJSONOptional
email (anyOf 1)stringAlternativeThe email address of the venue.
email (anyOf 2)nullAlternative
faxJSONOptional
fax (anyOf 1)stringAlternativeThe fax number of the venue.
fax (anyOf 2)nullAlternative
phoneJSONOptional
phone (anyOf 1)stringAlternativeThe phone number of the venue.
phone (anyOf 2)nullAlternative

Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone

FieldTypePresenceDescription and constraints
$objectRootA location. All fields are optional, but the object will hold as much information as possible.
address_line_1JSONOptional
address_line_1 (anyOf 1)stringAlternativeThe first line of the address.
address_line_1 (anyOf 2)nullAlternative
address_line_2JSONOptional
address_line_2 (anyOf 1)stringAlternativeThe second line of the address.
address_line_2 (anyOf 2)nullAlternative
administrative_areaJSONOptional
administrative_area (anyOf 1)stringAlternativeDepending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name.
administrative_area (anyOf 2)nullAlternative
cityJSONOptional
city (anyOf 1)stringAlternativeThe city where the address is located.
city (anyOf 2)nullAlternative
coordinatesJSONOptional
coordinates (anyOf 1)JSONAlternative
coordinates (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone coordinates The coordinates of the address The coordinates of an address
coordinates (anyOf 1) (allOf 2)JSONAll variants applyThe coordinates of the address.
coordinates (anyOf 2)nullAlternative
countryJSONOptional
country (anyOf 1)stringAlternativeThe country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country.
country (anyOf 2)nullAlternative
postal_codeJSONOptional
postal_code (anyOf 1)stringAlternativeThe postal code of the given address.
postal_code (anyOf 2)nullAlternative
timezoneJSONOptional
timezone (anyOf 1)stringAlternativeThe timezone in the given address.
timezone (anyOf 2)nullAlternative

Referenced models: Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone coordinates The coordinates of the address The coordinates of an address

Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone coordinates The coordinates of the address The coordinates of an address

FieldTypePresenceDescription and constraints
$objectRootThe coordinates of an address.
latitudeJSONRequired within parent
latitude (anyOf 1)numberAlternativeFormat: double
latitude (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
longitudeJSONRequired within parent
longitude (anyOf 1)numberAlternativeFormat: double
longitude (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get booking — response body — booking data Lodging-specific booking information reservation details

FieldTypePresenceDescription and constraints
$objectRootInformation on a reservation such as check-in, checkout, etc.
check_in_timeJSONRequired within parent
check_in_time (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp
check_in_time (allOf 2)JSONAll variants applyThe time when check-in will be available.
checkout_timeJSONRequired within parent
checkout_time (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp
checkout_time (allOf 2)JSONAll variants applyThe time limit for checkout.
confirmation_codeJSONOptional
confirmation_code (anyOf 1)stringAlternativeConfirmation code provided by the vendor.
confirmation_code (anyOf 2)nullAlternative
roomJSONOptional
room (anyOf 1)JSONAlternative
room (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information reservation details room Information on a room that was booked Information on a room that was booked
room (anyOf 1) (allOf 2)JSONAll variants apply
room (anyOf 2)nullAlternative

Referenced models: Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp, Get booking — response body — booking data Lodging-specific booking information reservation details room Information on a room that was booked Information on a room that was booked

Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp

FieldTypePresenceDescription and constraints
$objectRootA time within a booking, including local time in the relevant location, and a timestamp when possible.
local_timestringRequired within parentThe local time in the relevant location in the ISO 8601 format.
Format: date-time
timestampJSONOptional
timestamp (anyOf 1)stringAlternativeAn ISO 8601 timestamp.
Format: date-time
timestamp (anyOf 2)nullAlternative

Get booking — response body — booking data Lodging-specific booking information reservation details room Information on a room that was booked Information on a room that was booked

FieldTypePresenceDescription and constraints
$objectRootInformation on a room that was booked.
bed_countJSONOptional
bed_count (anyOf 1)JSONAlternative
bed_count (anyOf 1) (anyOf 1)integerAlternativeThe number of beds.
Format: int32
bed_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
bed_count (anyOf 2)nullAlternative
bed_typeJSONOptional
bed_type (anyOf 1)stringAlternativeThe kind of bed.
bed_type (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternativeA description of the room.
description (anyOf 2)nullAlternative
display_nameJSONOptional
display_name (anyOf 1)stringAlternativeThe name of the room as displayed to the user.
display_name (anyOf 2)nullAlternative

Get booking — response body — booking data Rail-specific booking information

FieldTypePresenceDescription and constraints
$objectRootRail-specific booking information.
journeysarrayRequired within parentThe journeys that make up this booking.
journeys[]ModelEach itemExpand Get booking — response body — booking data Rail-specific booking information journeys item
typestringOptional

Referenced models: Get booking — response body — booking data Rail-specific booking information journeys item

Get booking — response body — booking data Rail-specific booking information journeys item

FieldTypePresenceDescription and constraints
$objectRootA journey is composed of the legs that take a passenger from an origin to a final destination. E.g. if a traveler is going from Aberdeen to London, but they need to change trains in Edinburgh, the booking will contain 1 journey composed of 2 legs. The first leg is Aberdeen to Edinburgh, and the second is Edinburgh to London.
legsarrayRequired within parentThe legs that make up this journey.
legs[]ModelEach itemExpand Get booking — response body — booking data Rail-specific booking information journeys item legs item

Referenced models: Get booking — response body — booking data Rail-specific booking information journeys item legs item

Get booking — response body — booking data Rail-specific booking information journeys item legs item

FieldTypePresenceDescription and constraints
$objectRootA leg is a portion of the journey between two consecutive stops.
arrival_timeJSONRequired within parent
arrival_time (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp
arrival_time (allOf 2)JSONAll variants applyThe time when the leg ends.
departure_timeJSONRequired within parent
departure_time (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp
departure_time (allOf 2)JSONAll variants applyThe time when the leg starts.
destinationModelRequired within parentExpand Get booking — response body — booking data Rail-specific booking information journeys item legs item origin
durationJSONOptional
duration (anyOf 1)stringAlternativePT4h20M
duration (anyOf 2)nullAlternative
originModelRequired within parentExpand Get booking — response body — booking data Rail-specific booking information journeys item legs item origin
rail_classJSONOptional
rail_class (anyOf 1)JSONAlternative
rail_class (anyOf 1) (allOf 1)stringAll variants applyThe class of travel for a rail leg.
Known values: FIRST, STANDARD, BUSINESS, SLEEPER, STANDARD_PREMIUM, BUSINESS_PREMIUM, COACH, ROOM, EXECUTIVE
rail_class (anyOf 1) (allOf 2)JSONAll variants apply
rail_class (anyOf 2)nullAlternative
seatJSONOptional
seat (anyOf 1)JSONAlternative
seat (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Rail-specific booking information journeys item legs item seat The seat that has been reserved for this leg A seat in a train leg
seat (anyOf 1) (allOf 2)JSONAll variants applyThe seat that has been reserved for this leg.
seat (anyOf 2)nullAlternative
vehicleJSONOptional
vehicle (anyOf 1)JSONAlternative
vehicle (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Rail-specific booking information journeys item legs item vehicle The vehicle that will be used in this leg carrier, timetable id, type
vehicle (anyOf 1) (allOf 2)JSONAll variants applyThe vehicle that will be used in this leg.
vehicle (anyOf 2)nullAlternative

Referenced models: Get booking — response body — booking data Lodging-specific booking information reservation details check in time local time, timestamp, Get booking — response body — booking data Rail-specific booking information journeys item legs item seat The seat that has been reserved for this leg A seat in a train leg, Get booking — response body — booking data Rail-specific booking information journeys item legs item origin, Get booking — response body — booking data Rail-specific booking information journeys item legs item vehicle The vehicle that will be used in this leg carrier, timetable id, type

Get booking — response body — booking data Rail-specific booking information journeys item legs item origin

FieldTypePresenceDescription and constraints
$objectRootAn endpoint in a rail leg.
locationJSONOptional
location (anyOf 1)JSONAlternative
location (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone
location (anyOf 1) (allOf 2)JSONAll variants applyThe location of the station.
location (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the station.
name (anyOf 2)nullAlternative
typeJSONOptional
type (anyOf 1)JSONAlternative
type (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Rail-specific booking information journeys item legs item origin type string string
type (anyOf 1) (allOf 2)JSONAll variants apply
type (anyOf 2)nullAlternative

Referenced models: Get booking — response body — booking data Lodging-specific booking information lodging details location The location of the hotel address line 1, address line 2, administrative area, city, coordinates, country, postal code, timezone, Get booking — response body — booking data Rail-specific booking information journeys item legs item origin type string string

Get booking — response body — booking data Rail-specific booking information journeys item legs item origin type string string

FieldTypePresenceDescription and constraints
$stringRootThe kind of station. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey.
* `INDIVIDUAL` - A regular train station.
* `GROUP` - Stations grouped together, usually in a major European city. E.g. "London, Any".
* `METRO` - A metro/subway station.
* `BUS_STOP` - A bus stop.
* `FERRY_TERMINAL` - A ferry terminal.
Known values: INDIVIDUAL, GROUP, METRO, BUS_STOP, FERRY_TERMINAL

Get booking — response body — booking data Rail-specific booking information journeys item legs item seat The seat that has been reserved for this leg A seat in a train leg

FieldTypePresenceDescription and constraints
$objectRootA seat in a train leg.
coach_numberJSONOptional
coach_number (anyOf 1)stringAlternativeThe number of the coach.
coach_number (anyOf 2)nullAlternative
seat_numberJSONOptional
seat_number (anyOf 1)stringAlternativeThe number of the seat.
seat_number (anyOf 2)nullAlternative

Get booking — response body — booking data Rail-specific booking information journeys item legs item vehicle The vehicle that will be used in this leg carrier, timetable id, type

FieldTypePresenceDescription and constraints
$objectRootA vehicle used in a train leg. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey.
carrierJSONOptional
carrier (anyOf 1)stringAlternativeThe carrier that operates this leg. E.g. Amtrak, Thameslink.
carrier (anyOf 2)nullAlternative
timetable_idJSONOptional
timetable_id (anyOf 1)stringAlternativeThe timetable ID for the vehicle. The concept is similar to a flight number.
timetable_id (anyOf 2)nullAlternative
typeJSONOptional
type (anyOf 1)JSONAlternative
type (anyOf 1) (allOf 1)ModelAll variants applyExpand Get booking — response body — booking data Rail-specific booking information journeys item legs item vehicle The vehicle that will be used in this leg carrier, timetable id, type type string string
type (anyOf 1) (allOf 2)JSONAll variants apply
type (anyOf 2)nullAlternative

Referenced models: Get booking — response body — booking data Rail-specific booking information journeys item legs item vehicle The vehicle that will be used in this leg carrier, timetable id, type type string string

Get booking — response body — booking data Rail-specific booking information journeys item legs item vehicle The vehicle that will be used in this leg carrier, timetable id, type type string string

FieldTypePresenceDescription and constraints
$stringRootThe kind of vehicle to be used in a leg. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey.
* `TRAIN` - A regular train.
* `BUS` - A bus.
* `FERRY` - A ferry.
* `WALK`- Walking between stations.
* `TAXI` - A taxi between stations.
* `TRAM` - Tram/light rail.
* `METRO` - Metro/subway.
* `TUBE` - London underground.
Known values: TRAIN, BUS, FERRY, WALK, TAXI, TRAM, METRO, TUBE

Get booking — response body — policy out of policy, violations out of policy, violations

FieldTypePresenceDescription and constraints
$objectRootThe result of evaluating the customer's travel policy against this booking, as shown to the traveler when the booking was made. Mirrors the policy information available in the booking export. May be null when no policy was evaluated for the booking.
out_of_policybooleanRequired within parentWhether the booking is out of policy, i.e. at least one travel policy rule was broken.
violationsarrayOptionalThe specific travel policy rules that this booking violated. Empty when the booking is in policy.
violations[]ModelEach itemExpand Get booking — response body — policy out of policy, violations out of policy, violations violations item

Referenced models: Get booking — response body — policy out of policy, violations out of policy, violations violations item

Get booking — response body — policy out of policy, violations out of policy, violations violations item

FieldTypePresenceDescription and constraints
$objectRootA travel policy rule that a booking violated.
codeModelRequired within parentExpand Get booking — response body — policy out of policy, violations out of policy, violations violations item code
descriptionstringRequired within parentA human-readable description of the policy violation.

Referenced models: Get booking — response body — policy out of policy, violations out of policy, violations violations item code

Get booking — response body — policy out of policy, violations out of policy, violations violations item code

FieldTypePresenceDescription and constraints
$stringRootA machine-readable code identifying the policy rule that was violated:
* `MIN_DAYS_IN_ADVANCE` - The booking was made less than the minimum number of days in advance.
* `MAX_FARE_PER_TRAVELER` - The fare exceeds the maximum allowed per traveler.
* `TICKET_REFUNDABILITY` - The ticket refundability does not meet policy requirements.
* `TICKET_CHANGEABILITY` - The ticket changeability does not meet policy requirements.
* `AMOUNT_LIMIT_BY_FLIGHT_DURATION` - The fare exceeds the maximum allowed for the flight duration.
* `ALLOWED_CABIN_CLASSES_BY_DURATION` - The cabin class is not allowed for the flight duration.
* `ALLOWED_CABIN_CLASSES_BY_DURATION_DOMESTIC` - The cabin class is not allowed for the domestic flight duration.
* `ALLOWED_CABIN_CLASSES_BY_DURATION_INTERNATIONAL` - The cabin class is not allowed for the international flight duration.
* `MEDIAN_PRICE` - The price exceeds the median price.
* `LOWEST_LOGICAL_FARE` - The price exceeds the lowest logical fare.
* `MAX_STARS` - The hotel rating exceeds the maximum allowed.
* `DEFAULT_NIGHTLY_RATE` - The nightly rate exceeds the maximum allowed.
* `NIGHTLY_RATE_FOR_LOCATION` - The nightly rate exceeds the maximum allowed for the location.
* `MAX_HOTEL_BOOKING_PRICE` - The hotel booking price exceeds the maximum allowed.
* `ALLOWED_CAR_CLASSES` - The car class is not allowed.
* `MAX_DAILY_RATE` - The daily rate exceeds the maximum allowed.
* `OTHER` - A policy violation that is not covered by the other codes.
Known values: MIN_DAYS_IN_ADVANCE, MAX_FARE_PER_TRAVELER, TICKET_REFUNDABILITY, TICKET_CHANGEABILITY, AMOUNT_LIMIT_BY_FLIGHT_DURATION, ALLOWED_CABIN_CLASSES_BY_DURATION, ALLOWED_CABIN_CLASSES_BY_DURATION_DOMESTIC, ALLOWED_CABIN_CLASSES_BY_DURATION_INTERNATIONAL, MEDIAN_PRICE, LOWEST_LOGICAL_FARE, MAX_STARS, DEFAULT_NIGHTLY_RATE, NIGHTLY_RATE_FOR_LOCATION, MAX_HOTEL_BOOKING_PRICE, ALLOWED_CAR_CLASSES, MAX_DAILY_RATE, OTHER

Get booking — response body — status

FieldTypePresenceDescription and constraints
$stringRootThe status of the booking:
* `HOLD` - The booking is a hold, and may be canceled without being charged.
* `PENDING` - Some action needs to be completed before the booking is confirmed. Usually the action is the payment being confirmed.
* `CONFIRMED` - The booking is confirmed.
* `COMPLETED` - The booking has already happened.
* `CANCELED` - The booking has been canceled.
* `IN_PROGRESS` - The booking is currently in progress.
* `REFUNDED` - A refund has been issued. It may or may not be a full refund.
* `VOIDED` - Voided is similar to (and can be treated the same as) canceled.
* `PROCESSING` - The booking has been created or changed, but confirmation from the vendor has not been received yet.
* `UNCONFIRMED` - The booking was in the `PROCESSING` state for too long and some action is probably required to get this booking confirmed.
* `AIRLINE_CONTROL` - The airline has taken control of the booking and further updates may not be visible.
* `PAYMENT_DECLINED` - The payment for the booking has failed.
* `SCHEDULE_CHANGE` - Some change has happened to the booking schedule, e.g. the flight getting canceled and the passenger reallocated to another flight. Travel support should reach out to confirm the traveler accepts the new schedule.
* `APPROVAL_REQUESTED` - The booking is subject to approval, and it is waiting for a review.
* `APPROVAL_DENIED` - A reviewer has denied the booking, or the deadline to approve the booking has passed and it got canceled.
* `CANCELLATION_IN_PROGRESS` - The booking is currently being canceled.
Known values: HOLD, PENDING, CONFIRMED, COMPLETED, CANCELED, IN_PROGRESS, REFUNDED, VOIDED, PROCESSING, UNCONFIRMED, AIRLINE_CONTROL, PAYMENT_DECLINED, SCHEDULE_CHANGE, APPROVAL_REQUESTED, APPROVAL_DENIED, CANCELLATION_IN_PROGRESS

Get trip — response body

FieldTypePresenceDescription and constraints
$objectRootA trip representation.
billable_atJSONOptional
billable_at (anyOf 1)stringAlternativeThe time when the trip became billable. If absent, the trip is currently not billable.
Format: date-time
billable_at (anyOf 2)nullAlternative
booker_user_idstringRequired within parentThe ID of the user who booked the trip. If the trip was created on copilot mode, this will be the ID of the user on behalf of whom the trip was booked.
created_atstringRequired within parentThe time when the trip was created.
Format: date-time
custom_fieldsJSONOptional
custom_fields (anyOf 1)arrayAlternativeCustom field values associated with this resource.
custom_fields (anyOf 1)[]ModelEach itemExpand Get trip — response body — custom fields Custom field values associated with this resource item
custom_fields (anyOf 2)nullAlternative
ends_atJSONOptional
ends_at (anyOf 1)stringAlternativeThe time when the last booking in the trip ends.
Format: date-time
ends_at (anyOf 2)nullAlternative
idstringRequired within parentThe ID of the trip.
nameJSONOptional
name (anyOf 1)stringAlternativeThe name of the trip as seen in the dashboard.
Maximum length: 100
name (anyOf 2)nullAlternative
starts_atJSONOptional
starts_at (anyOf 1)stringAlternativeThe time when the first booking in the trip starts.
Format: date-time
starts_at (anyOf 2)nullAlternative
statusJSONRequired within parent
status (allOf 1)stringAll variants applyThe current status of a trip.
Known values: PENDING, UPCOMING, IN_PROGRESS, COMPLETED, CANCELED, REFUNDED, VOIDED, DRAFT, DELETED, PROCESSING, UNCONFIRMED, AIRLINE_CONTROL, PAYMENT_DECLINED, SCHEDULE_CHANGE, HOLD, APPROVAL_REQUESTED, APPROVAL_DENIED, CANCELLATION_IN_PROGRESS
status (allOf 2)JSONAll variants applyThe current status of the trip.
travelerJSONOptional
traveler (anyOf 1)JSONAlternative
traveler (anyOf 1) (allOf 1)ModelAll variants applyExpand Get trip — response body — traveler / type: EMPLOYEE, GUEST type: EMPLOYEE, GUEST
traveler (anyOf 1) (allOf 2)JSONAll variants applyInformation on the person who will be traveling.
traveler (anyOf 2)nullAlternative
trip_referenceJSONOptional
trip_reference (anyOf 1)stringAlternativeThe trip reference number shown in the dashboard and used when contacting Brex Support. This is the reference from the travel provider, not the Brex internal trip ID. May be null if the trip has no associated reference.
trip_reference (anyOf 2)nullAlternative
updated_atstringRequired within parentThe time when the latest trip update happened.
Format: date-time
versionJSONRequired within parent
version (anyOf 1)integerAlternativeThe current version of the trip.
Format: int32
Minimum: 1
version (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item, Get trip — response body — traveler / type: EMPLOYEE, GUEST type: EMPLOYEE, GUEST

Get trip — response body — custom fields Custom field values associated with this resource item

FieldTypePresenceDescription and constraints
$objectRoot
keystringRequired within parentThe key of the custom field.
valueJSONRequired within parent
value (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values
value (allOf 2)JSONAll variants applyThe value of the custom field.
value (allOf 2) (anyOf 1)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field String value
value (allOf 2) (anyOf 2)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Decimal value
value (allOf 2) (anyOf 3)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Boolean value
value (allOf 2) (anyOf 4)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Enum value
value (allOf 2) (anyOf 5)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Timestamp value
value (allOf 2) (anyOf 6)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value
value (allOf 2) (anyOf 7)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Money value
value (allOf 2) (anyOf 8)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Option string value
value (allOf 2) (anyOf 9)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field String list value
value (allOf 2) (anyOf 10)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Decimal list value
value (allOf 2) (anyOf 11)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Boolean list value
value (allOf 2) (anyOf 12)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Enum list value
value (allOf 2) (anyOf 13)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Timestamp list value
value (allOf 2) (anyOf 14)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value
value (allOf 2) (anyOf 15)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Money list value
value (allOf 2) (anyOf 16)ModelAlternativeExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Option string list value

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Boolean list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Boolean value, Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Decimal list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Decimal value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Enum list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Enum value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Money list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Money value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Option string list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Option string value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field String list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field String value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Timestamp list value, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Timestamp value

Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

FieldTypePresenceDescription and constraints
$objectRootBase class for custom field values
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
value_typeJSONRequired within parent
value_type (allOf 1)stringAll variants applyThe type of the custom field value.
Known values: SINGLE_VALUE, LIST
value_type (allOf 2)JSONAll variants applyThe type of the custom field value.

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Boolean list value

FieldTypePresenceDescription and constraints
$objectRootBoolean list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]booleanEach itemThe data of the custom field.
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Boolean value

FieldTypePresenceDescription and constraints
$objectRootBoolean value for a custom field
dataJSONOptional
data (anyOf 1)booleanAlternativeThe data of the custom field.
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value

FieldTypePresenceDescription and constraints
$objectRootDate list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]stringEach itemThe data of the custom field.
Format: date
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values

FieldTypePresenceDescription and constraints
$objectRootMultiple value wrapper for custom fields
value_typeJSONRequired within parent
value_type (allOf 1)stringAll variants applyThe type of the custom field value.
Known values: SINGLE_VALUE, LIST
value_type (allOf 2)JSONAll variants applyThe type of the custom field value.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value

FieldTypePresenceDescription and constraints
$objectRootDate value for a custom field
dataJSONOptional
data (anyOf 1)stringAlternativeThe data of the custom field.
Format: date
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values

FieldTypePresenceDescription and constraints
$objectRootSingle value wrapper for custom fields
value_typeJSONRequired within parent
value_type (allOf 1)stringAll variants applyThe type of the custom field value.
Known values: SINGLE_VALUE, LIST
value_type (allOf 2)JSONAll variants applyThe type of the custom field value.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Decimal list value

FieldTypePresenceDescription and constraints
$objectRootDecimal list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]JSONEach item
data (anyOf 1)[] (anyOf 1)numberAlternativeThe data of the custom field.
data (anyOf 1)[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Decimal value

FieldTypePresenceDescription and constraints
$objectRootDecimal value for a custom field
dataJSONOptional
data (anyOf 1)JSONAlternative
data (anyOf 1) (anyOf 1)numberAlternativeThe data of the custom field.
data (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Enum list value

FieldTypePresenceDescription and constraints
$objectRootEnum list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]stringEach itemThe data of the custom field.
Format: enum
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Enum value

FieldTypePresenceDescription and constraints
$objectRootEnum value for a custom field
dataJSONOptional
data (anyOf 1)stringAlternativeThe data of the custom field.
Format: enum
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Money list value

FieldTypePresenceDescription and constraints
$objectRootMoney list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]ModelEach itemExpand Get transfer — response body — amount
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get transfer — response body — amount, Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Money value

FieldTypePresenceDescription and constraints
$objectRootMoney value for a custom field
dataJSONOptional
data (anyOf 1)JSONAlternative
data (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
data (anyOf 1) (allOf 2)JSONAll variants applyThe data of the custom field.
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get transfer — response body — amount, Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Option string list value

FieldTypePresenceDescription and constraints
$objectRootOption string list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]ModelEach itemExpand Get user — response body — custom fields array item value The value of the custom field Option string list value data array item
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get user — response body — custom fields array item value The value of the custom field Option string list value data array item, Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Option string value

FieldTypePresenceDescription and constraints
$objectRootOption string value for a custom field
dataJSONOptional
data (anyOf 1)JSONAlternative
data (anyOf 1) (allOf 1)ModelAll variants applyExpand Get user — response body — custom fields array item value The value of the custom field Option string list value data array item
data (anyOf 1) (allOf 2)JSONAll variants applyThe data of the custom field.
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get user — response body — custom fields array item value The value of the custom field Option string list value data array item, Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field String list value

FieldTypePresenceDescription and constraints
$objectRootString list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]stringEach itemThe data of the custom field.
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field String value

FieldTypePresenceDescription and constraints
$objectRootString value for a custom field
dataJSONOptional
data (anyOf 1)stringAlternativeThe data of the custom field.
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Timestamp list value

FieldTypePresenceDescription and constraints
$objectRootTimestamp list value for a custom field
dataJSONOptional
data (anyOf 1)arrayAlternative
data (anyOf 1)[]stringEach itemThe data of the custom field.
Format: date-time
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date list value Base class for custom field values

Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Timestamp value

FieldTypePresenceDescription and constraints
$objectRootTimestamp value for a custom field
dataJSONOptional
data (anyOf 1)stringAlternativeThe data of the custom field.
Format: date-time
data (anyOf 2)nullAlternative
data_typeJSONRequired within parent
data_type (allOf 1)stringAll variants applyThe type of the custom field data.
Known values: STRING, DECIMAL, BOOLEAN, ENUM, TIMESTAMP, DATE, MONEY, OPTION_STRING
data_type (allOf 2)JSONAll variants applyThe type of the custom field data.
$ (allOf 1)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values
$ (allOf 2)ModelAll variants applyExpand Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values

Referenced models: Get trip — response body — custom fields Custom field values associated with this resource item value Base class for custom field values, Get trip — response body — custom fields Custom field values associated with this resource item value The value of the custom field Date value Base class for custom field values

Get trip — response body — traveler / type: EMPLOYEE, GUEST type: EMPLOYEE, GUEST

FieldTypePresenceDescription and constraints
$objectRootInformation on the person who will be traveling.
guest_emailJSONOptional
guest_email (anyOf 1)stringAlternativeIf the traveler is a guest, this is their email.
guest_email (anyOf 2)nullAlternative
nameJSONOptional
name (anyOf 1)JSONAlternative
name (anyOf 1) (allOf 1)ModelAll variants applyExpand Get trip — response body — traveler / type: EMPLOYEE, GUEST type: EMPLOYEE, GUEST name The name of the traveler The name of the traveler
name (anyOf 1) (allOf 2)JSONAll variants apply
name (anyOf 2)nullAlternative
typestringRequired within parentWhether the trip is for an employee or a guest.
Known values: EMPLOYEE, GUEST
user_idJSONOptional
user_id (anyOf 1)stringAlternativeIf the traveler is an employee, this is their user ID.
user_id (anyOf 2)nullAlternative

Referenced models: Get trip — response body — traveler / type: EMPLOYEE, GUEST type: EMPLOYEE, GUEST name The name of the traveler The name of the traveler

Get trip — response body — traveler / type: EMPLOYEE, GUEST type: EMPLOYEE, GUEST name The name of the traveler The name of the traveler

FieldTypePresenceDescription and constraints
$objectRootThe name of the traveler.
first_namestringOptionalThe traveler's first name.
last_namestringOptionalThe traveler's last name.
middle_nameJSONOptional
middle_name (anyOf 1)stringAlternativeThe traveler's middle name.
middle_name (anyOf 2)nullAlternative
suffixJSONOptional
suffix (anyOf 1)stringAlternativeThe suffix in the traveler's name.
suffix (anyOf 2)nullAlternative

List trip bookings — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get booking — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get booking — response body

List trips — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get trip — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get trip — response body

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.