Travel API (1.0)

Download OpenAPI specification:Download

Admin: developer-access@brex.com URL: https://brex.com

Brex Travel External API.

Trips

Endpoints for getting trip data.

List trips

Lists trips according to the filters passed in the query string.

SecurityOAuth2

Request

query Parameters

cursor	string or null
limit	integer or null <int64>
last_updated_after	string or null <date-time>

Responses

200

A page with a list of trips.

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal server error

get/v1/trips

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"next_cursor": "string",
"items": [{"id": "trip_cl9rh1n8g001e0j84w6fb4fd1",
"created_at": "2017-12-27T15:42:30Z",
"updated_at": "2017-12-27T15:42:30Z",
"name": "Trip to Rio de Janeiro",
"booker_user_id": "cuuser_cky0xs54b004h01pidi0pcuz1",
"status": "string",
"traveler": {"type": "EMPLOYEE",
"name": {"first_name": "John",
"middle_name": "Paul",
"last_name": "Doe",
"suffix": "Jr."
},
"guest_email": "guest@gmail.com",
"user_id": "cuuser_cky0xs54b004h01pidi0pcuz1"
},
"version": 2,
"billable_at": "2017-12-27T15:42:30Z",
"starts_at": "2017-12-27T15:42:30Z",
"ends_at": "2017-12-27T15:42:30Z"
}
]
}

Get trip

Retrieves a trip by ID.

SecurityOAuth2

Request

path Parameters

trip_id

required

string

Responses

200

The trip that was retrieved.

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/v1/trips/{trip_id}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"id": "trip_cl9rh1n8g001e0j84w6fb4fd1",
"created_at": "2017-12-27T15:42:30Z",
"updated_at": "2017-12-27T15:42:30Z",
"name": "Trip to Rio de Janeiro",
"booker_user_id": "cuuser_cky0xs54b004h01pidi0pcuz1",
"status": "string",
"traveler": {"type": "EMPLOYEE",
"name": {"first_name": "John",
"middle_name": "Paul",
"last_name": "Doe",
"suffix": "Jr."
},
"guest_email": "guest@gmail.com",
"user_id": "cuuser_cky0xs54b004h01pidi0pcuz1"
},
"version": 2,
"billable_at": "2017-12-27T15:42:30Z",
"starts_at": "2017-12-27T15:42:30Z",
"ends_at": "2017-12-27T15:42:30Z"
}

List trip bookings

Lists the bookings within a trip.

SecurityOAuth2

Request

path Parameters

trip_id

required

string

query Parameters

cursor	string or null
limit	integer or null <int64>

Responses

200

A page with a list of bookings.

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/v1/trips/{trip_id}/bookings

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"next_cursor": "string",
"items": [{"id": "booking_cl9t5dnu800040m3071dandeq",
"created_at": "2017-12-27T15:42:30Z",
"updated_at": "2017-12-27T15:42:30Z",
"trip_id": "trip_cl9rh1n8g001e0j84w6fb4fd1",
"version": 2,
"type": "AIR",
"status": "CONFIRMED",
"source": "BREX_TRAVEL",
"booking_data": {"journeys": [{"flights": [{"origin": null,
"destination": null,
"departure_time": null,
"arrival_time": null,
"duration": null,
"confirmation_code": null,
"cabin_class": null,
"marketing_flight": null,
"operating_flight": null,
"seat": null
}
],
"status": "string",
"cabin_display_name": "Flexible Economy"
}
],
"tickets": [{"number": "0017959463925",
"issue_date": "2017-12-27"
}
],
"redress_number": {"issuing_country": "BR",
"document_number": "1231231"
},
"known_traveler_number": {"issuing_country": "BR",
"document_number": "1231231"
},
"type": "string"
}
}
]
}

Get booking

Retrieves a booking by trip and booking ID.

SecurityOAuth2

Request

path Parameters

trip_id required	string
booking_id required	string

Responses

200

The booking that was retrieved.

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/v1/trips/{trip_id}/bookings/{booking_id}

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"id": "booking_cl9t5dnu800040m3071dandeq",
"created_at": "2017-12-27T15:42:30Z",
"updated_at": "2017-12-27T15:42:30Z",
"trip_id": "trip_cl9rh1n8g001e0j84w6fb4fd1",
"version": 2,
"type": "AIR",
"status": "CONFIRMED",
"source": "BREX_TRAVEL",
"booking_data": {"journeys": [{"flights": [{"origin": {"airport_code": "GIG",
"terminal": "T2",
"gate": "B13",
"airport_location": {"country": null,
"administrative_area": null,
"city": null,
"postal_code": null,
"address_line_1": null,
"address_line_2": null,
"coordinates": null,
"timezone": null
}
},
"destination": {"airport_code": "GIG",
"terminal": "T2",
"gate": "B13",
"airport_location": {"country": null,
"administrative_area": null,
"city": null,
"postal_code": null,
"address_line_1": null,
"address_line_2": null,
"coordinates": null,
"timezone": null
}
},
"departure_time": {"local_time": "2019-08-24T14:15:22Z",
"timestamp": "2017-12-27T15:42:30Z"
},
"arrival_time": {"local_time": "2019-08-24T14:15:22Z",
"timestamp": "2017-12-27T15:42:30Z"
},
"duration": "PT4h20M",
"confirmation_code": "PWZRTQ",
"cabin_class": "string",
"marketing_flight": {"airline_code": "G3",
"number": "1234",
"airline_name": "GOL Linhas Aereas S.A."
},
"operating_flight": {"airline_code": "G3",
"number": "1234",
"airline_name": "GOL Linhas Aereas S.A."
},
"seat": {"number": "31D",
"status": "string"
}
}
],
"status": "string",
"cabin_display_name": "Flexible Economy"
}
],
"tickets": [{"number": "0017959463925",
"issue_date": "2017-12-27"
}
],
"redress_number": {"issuing_country": "BR",
"document_number": "1231231"
},
"known_traveler_number": {"issuing_country": "BR",
"document_number": "1231231"
},
"type": "string"
}
}