v1
latestSwagger 2.02026-08-04283399898.4 KBrentals
Read one rental
get/rentals/{id}
Path parameters
idinteger required
Response
HTTP status code 200 and rental model
auto_insurance_typestring
booking_leeway_daysinteger nullable
bypass_new_york_regulationsboolean
Admins can mark a vehicle to bypass New York regulations check
can_manage_tax_ratesboolean
used by dashboard to disable tax editing
cancel_policystring nullable
cancel_policy_combo_bookingsstring nullable
check_ininteger
check_outinteger
checkout_questionsobject[]
DBMSISlice is a []string with database conversion methods
createdstring
Admin, owner Fields
current_location_idinteger
custom_insurance_textstring nullable
delivery_usage_item_idinteger
descriptionstring
description_includedstring
description_otherstring
description_recommendationsstring
eligible_for_custom_tax_ratesboolean
We allow custom taxes for Quebec which has also system tax rates
eligible_for_system_tax_ratesboolean
For wheelbase so we can show when a rental will use system tax rates
exempt_rental_sales_taxboolean
externalboolean nullable
external_site_urlstring
{"stackTrail":"components:schemas:DBInterfaceMap","oasType":"schema","type":"unknown","description":"DBInterfaceMap is a map[string]interface{} with database conversion methods","extensionFields":{"x-go-package":"github.com/outdoorsy/api/utils"}}
first_publishedstring
free_form_typedboolean
free form typed flag
generator_usage_item_idinteger
group_on_mapboolean
has_checkout_questionsboolean
has_completed_lyrvboolean
hiddenboolean
hidden_reasonstring nullable
idinteger
images_verifiedboolean nullable
images_verified_byinteger nullable
import_idstring
inactiveboolean
instant_bookboolean nullable
instant_book_ban_datestring
instant_book_bannedboolean
Rental-level instant book ban (stored in metadata, combo bookings only)
instant_book_leewayinteger nullable
instant_book_typestring
insurance_coveragestring
insurance_renter_adjustableboolean nullable
interior_primary_image_idinteger
interior_primary_image_urlstring
internal_idstring
internal_notesstring
last_publishedstring
last_unpublish_datestring
{"stackTrail":"components:schemas:DBInterfaceMap","oasType":"schema","type":"unknown","description":"DBInterfaceMap is a map[string]interface{} with database conversion methods","extensionFields":{"x-go-package":"github.com/outdoorsy/api/utils"}}
{"stackTrail":"components:schemas:IMap","oasType":"schema","type":"unknown","extensionFields":{"x-go-package":"github.com/outdoorsy/api/pkg/jsonb"}}
mileage_usage_item_idinteger
minimum_daysinteger nullable
minimum_depositinteger nullable
minimum_renter_ageinteger
namestring
ny_insurance_warningboolean
od_stays_opt_inboolean
od_stays_opt_in_eligibleboolean
od_stays_opt_in_missing_requirementsstring[]
one_way_rental_maximum_radiusinteger nullable
one_way_rental_requestsboolean nullable
original_urlstring
Importing
parent_idinteger
grouping functionality
photo_scoreinteger nullable
positioninteger
primary_image_idinteger
primary_image_urlstring
publish_field_errorsstring[]
publishedboolean
rejected_images_countinteger
holds the count of images with status rejected and ignore rejected false
rental_categorystring
request_less_than_minimum_daysinteger
require_insuranceboolean nullable
require_roadsideboolean nullable
review_notesstring nullable
review_statusstring nullable
roamly_policy_numberstring
sd_waiver_enabledboolean nullable
seatbeltsinteger
{"stackTrail":"components:schemas:DBInterfaceMap","oasType":"schema","type":"unknown","description":"DBInterfaceMap is a map[string]interface{} with database conversion methods","extensionFields":{"x-go-package":"github.com/outdoorsy/api/utils"}}
sleepsinteger
sleeps_adultsinteger
sleeps_kidsinteger
smart_pricing_enabledboolean
smart_pricing_maxinteger
smart_pricing_mininteger
smart_pricing_modestring
snooze_expiration_datestring
sortnumber double
Admin Fields
{"stackTrail":"components:schemas:DBInterfaceMap","oasType":"schema","type":"unknown","description":"DBInterfaceMap is a map[string]interface{} with database conversion methods","extensionFields":{"x-go-package":"github.com/outdoorsy/api/utils"}}
summarystring
tax_rate_idsinteger[]
tollspot_idinteger
turnaround_days_afterinteger nullable
turo_vehicle_idstring
typestring
unpublish_reasonstring
updatedstring
use_system_tax_ratesboolean
used by rental listing page to display system tax notice
vehicle_titlestring
waived_insurance_textstring nullable