Skip to main content

Hotel Stay Tools

Query hotel stay records — accommodation bookings with check-in/check-out dates, room counts, and associated CO₂e emissions. This is Scope 3 Category 6 (business travel) data.

list_hotel_stays

List hotel stay records with optional filters. Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringNodefault orgOrganization UUID
statusstringNoStatus filter: active, deleted
start_datestringNoFilter stays from this date (YYYY-MM-DD)
end_datestringNoFilter stays until this date (YYYY-MM-DD)
namestringNoFilter by hotel name (partial match)
pageintegerNo1Page number
sizeintegerNo50Results per page
Example response:
{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Team offsite — Madrid",
      "check_in_date": "2024-11-04",
      "check_out_date": "2024-11-07",
      "country": "ES",
      "address": "Gran Vía 28, Madrid, Spain",
      "hotel_name": "Hotel Gran Vía",
      "rooms": 3,
      "status": "active",
      "source": "manual",
      "co2e": 18.54,
      "file_id": null,
      "file_name": null,
      "created_at": "2024-11-01T09:00:00Z",
      "updated_at": "2024-11-01T09:00:00Z"
    }
  ],
  "total": 42,
  "page": 1,
  "size": 50,
  "pages": 1
}
Key response fields:
FieldDescription
nameDescription or label for the stay (e.g. “Team offsite — Madrid”)
hotel_nameName of the hotel
check_in_date / check_out_dateStay dates (number of nights = difference between these)
roomsNumber of rooms booked
countryISO country code of the hotel location
co2eCalculated CO₂e emissions in kg
sourceHow the record was created: manual, bulk_upload, or api
Example prompts:
"List our hotel stays for Q1 2024"
"Show hotel stays at Marriott properties"
"How many hotel nights did we book last year?"
"What are the emissions from our hotel stays in 2025?"

Workflow

  1. List hotel stayslist_hotel_stays to query stays by date range or hotel name
  2. View travel emissionsget_greenhouse_gas_emissions with category=travels for aggregated business travel totals
  3. Compare with flightslist_business_travels to see flight/train records alongside hotel data

API: List Hotel Stays

REST API equivalent with additional filters

Business Travels

Flight and train journey records

Emissions

Aggregated Scope 3 travel emissions

CLI

Manage hotel stays from the command line