/
OU
outdoorsy
/
Outdoorsy API Documentation
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Subscribe
v1
latest
Swagger 2.0
2026-08-04
283
399
898.4 KB
twoFactorAuth
Create and send verification code
post
/2fa/send
Request body
TwoFARequest
required
session_id_2fa
string
type
string
All 283 operations
post
/2fa/send
post
/2fa/setup-method
patch
/2fa/verify
get
List AI reply suggestions for a conversation.
get
/admin/announcement-groups
post
/admin/announcement-groups
get
/admin/announcement-groups/{announcement_group_id}
delete
/admin/announcement-groups/{announcement_group_id}
patch
/admin/announcement-groups/{announcement_group_id}
get
/admin/announcements
post
/admin/announcements
get
/admin/announcements/{announcement_id}
delete
/admin/announcements/{announcement_id}
patch
/admin/announcements/{announcement_id}
get
/admin/users/banks/payouts-triggered
post
/admin/users/banks/update
post
/admin/users/{user_id}/resend-confirmation
get
Returns a list of validations in the system.
get
Returns a validation in the system by its ID.
delete
Flags a validation as deleted.
post
Duplicates a validation, overwriting its arguments to copy its data to another object in the system. This is intended to be used when creating a more specific version of a validation. For example, a user-level validation that needs to be \"locked\" to a booking by using a user_id,booking_id tuple. Send the tuple you wish this duplicate to use as its identifier as the new_args key in the body.
post
Forces an validation into a `passed` state.
get
Returns the historical list of validation entries.
post
Retry a validation request if failed or error
get
/aggregate-reviews-for-locality
get
/amenities
get
/announcements
get
/announcements/{announcement_id}
post
/announcements/{announcement_id}/read
post
Register a new user given a name and email address.
post
/auth/creds/forgot
post
/auth/creds/login
post
/auth/creds/resend
post
Register a new self-serve dealer account.
get
Redirect endpoint after performing oauth flow with facebook, google, apple.
get
Entry point for starting oauth flow with specified provider.
get
Returns a breakdown of previous rentals, bookings or pending reviews.
get
Returns list of available rentals for a given date range.
get
/bids
post
/bids
get
/bids/available
post
/bids/{bid_id}/bid-matches/{bid_match_id}/renter-decline
get
/bids/{id}
delete
/bids/{id}
patch
/bids/{id}
post
/bids/{id}/decline
get
/bookings
post
/bookings
get
/bookings/soonest
get
/bookings/stage
get
/bookings/{booking_id}/bundles
post
Assign insurance bundle to booking (assign, replace or delete).
get
/bookings/{booking_id}/bundles/{bundle_id}
post
/bookings/{booking_id}/calculate-delivery
post
/bookings/{booking_id}/collect-post-trip-charges
post
/bookings/{booking_id}/items
post
Updates a batch of items on the booking.
post
Updates a batch of items on the booking.
post
/bookings/{booking_id}/items/copy
get
/bookings/{booking_id}/items/{id}
delete
/bookings/{booking_id}/items/{id}
patch
/bookings/{booking_id}/items/{id}
patch
Updates the consigned pay amount for an item.
delete
/bookings/{booking_id}/payout/{transaction_id}
get
/bookings/{booking_id}/proposals
post
/bookings/{booking_id}/proposals
delete
/bookings/{booking_id}/proposals/batch-delete
patch
/bookings/{booking_id}/proposals/batch-update
get
/bookings/{booking_id}/proposals/{id}
delete
/bookings/{booking_id}/proposals/{id}
patch
/bookings/{booking_id}/proposals/{id}
get
/bookings/{booking_id}/proposals/{id}/act
get
/bookings/{booking_id}/scheduled-emails
get
Returns the list of available premium services for the requested booking.
delete
/bookings/{booking_id}/services/{id}
get
Returns the booking service associated with the booking.
post
Adds an available premium service to the booking based on the service id.
patch
Updates an existing premium service on this booking using the service id.
get
/bookings/{booking_id}/system-emails
post
/bookings/{booking_id}/system-emails/resend
get
Returns all transactions for a booking. Optionally filtered by type.
post
/bookings/{booking_id}/transactions
get
/bookings/{booking_id}/transactions/{transaction_id}
delete
/bookings/{booking_id}/transactions/{transaction_id}
patch
/bookings/{booking_id}/transactions/{transaction_id}
post
Returns the booking weather from Roamly.
get
/bookings/{id}
delete
Archives the booking which hides it from view.
patch
Updates the booking with requested changes.
get
/bookings/{id}/cancellation-details
post
/bookings/{id}/collect-overage-fee
patch
Progresses the status of the booking to the requested state.
get
/bundles
post
/bundles
post
/bundles/{bundle_id}/features
get
/bundles/{bundle_id}/features/{id}
delete
/bundles/{bundle_id}/features/{id}
patch
/bundles/{bundle_id}/features/{id}
post
/bundles/{bundle_id}/rules
get
/bundles/{bundle_id}/rules/{id}
delete
/bundles/{bundle_id}/rules/{id}
patch
/bundles/{bundle_id}/rules/{id}
get
/bundles/{id}
delete
/bundles/{id}
patch
/bundles/{id}
get
/checkout_steps/{booking_id}
patch
/checkout_steps/{booking_id}
get
/confirm
get
/conversations
post
/conversations
get
/conversations/{id}
put
/conversations/{id}
delete
/conversations/{id}
get
Get AI-generated reply suggestion for a conversation.
get
Converts currency.
get
/favorites
post
/favorites
delete
/favorites
delete
/favorites/{id}
get
/files
post
/files
get
/files/{id}
delete
/files/{id}
patch
/files/{id}
get
/gateways/fund_creation_form
get
/gateways/list_options
get
Send referral communications to a list of friends.
get
Read a gift card.
post
Send referral communications to a list of friends.
get
Returns list of ICSCalendar for a given user. Optionally could filter by user owned rental.
post
Create calendar record with pending calendar log and trigger SyncICSCalendar job to sync it.
post
Trigger a job to sync all user eligible (last sync started at least 3 minutes ago) callendars. Optionally could be triggered for a specific user's calendar or user owned rental.
delete
Delete calendar record with and calendar's logs.
get
Returns an .ics file with Outdoorsy availability per rental.
get
Returns URL to the .ics file download link.
get
/items
post
/items
get
/items/{id}
delete
/items/{id}
patch
/items/{id}
get
/locations
post
/locations
get
/locations/{id}
delete
/locations/{id}
patch
/locations/{id}
get
/locations/{owner_id}/for-pro-page
get
/message-templates
post
Creates a new message template
get
Get message template by id
delete
Archive a message template
patch
Update message template by id
get
/messages
post
Creates a new message as part of a conversation between owner and renter.
get
/messages/twilio/sms
get
/messages/{id}
patch
/messages/{id}
get
/notes-to-renters
post
/notes-to-renters
delete
/notes-to-renters/{id}
patch
/notes-to-renters/{id}
get
/notices
get
Return estimated price when listing your vehicle by make, model and location.
get
Return price aggregation for nearby rentals around given lat and lng in 50 miles radius.
get
Return estimated price when listing your vehicle by make, model and location.
post
Generates a quote for a given rental based on start and stop dates.
get
/quotes/{id}/services
post
Send referral communications to a list of friends.
get
Send referral communications to a list of friends.
get
Send referral communications to a list of friends.
get
Check eligibility of the referee.
get
List available rental items categories
get
Admin endpoint to list all rental items categories with comprehensive filtering and sorting
post
Admin endpoint to create a new rental items category
get
Admin endpoint to retrieve add-on triage analytics for a time period
patch
Admin endpoint to update a rental items category
get
Read many rentals GetFleetVehicle retrieves vehicle data from the Fleet service for a rental. This includes real-time information like odometer reading, connection status, and other attributes. The frontend can use this data to update mileage fields or display vehicle status.
post
/rentals
get
/rentals/vehicle-types
get
/rentals/{id}
delete
/rentals/{id}
patch
/rentals/{id}
post
Create consignment for a rental.
post
/rentals/{id}/duplicate
patch
/rentals/{id}/price
post
/rentals/{id}/remove
patch
/rentals/{id}/vin
post
/rentals/{rental_id}/delivery
patch
/rentals/{rental_id}/image-order
get
/rentals/{rental_id}/images
post
Creates, updates, and deletes a set of rental images based on list of objects.
post
/rentals/{rental_id}/images/raw
get
/rentals/{rental_id}/images/{id}
delete
/rentals/{rental_id}/images/{id}
patch
/rentals/{rental_id}/images/{id}
get
Returns the list of available premium services for the request rental.
get
/reports/checkout-questions
get
/reports/credit
get
/reports/end-of-day
get
/reports/rental-prep
get
/reports/security-deposits
get
/reviews
post
/reviews
get
/reviews-for-locality
get
/reviews/{id}
patch
/reviews/{id}
get
/search/bookings
get
/search/global
get
/search/meta-count
get
/search/parent-bookings
get
/search/rentals
get
/search/{user_id}/customers
get
/special-hours
post
/special-hours
get
/special-hours/{id}
delete
/special-hours/{id}
patch
/special-hours/{id}
get
/towable_features
get
/towing_info
get
Global read many transactions, across all bookings.
get
/transactions/batch-events
get
/transactions/batches/{batch_id}/details
get
/transactions/deposits
get
/transactions/deposits/details
get
/transactions/payout-history
get
Returns an array of usage based items owned by the user.
post
/usage-based-items
get
Returns the usage based item by id.
delete
/usage-based-items/:id
patch
Update record by id.
get
/usage-based-items/{usage_based_item_id}/tiers
post
/usage-based-items/{usage_based_item_id}/tiers
get
/usage-based-items/{usage_based_item_id}/tiers/{id}
delete
/usage-based-items/{usage_based_item_id}/tiers/{id}
patch
/usage-based-items/{usage_based_item_id}/tiers/{id}
get
/user-notice-events
post
/user-notice-events
get
/user-notice-events/{event_id}
put
/user-notice-events/{event_id}
patch
/user-notice-events/{event_id}
get
/users
get
/users/authorization
post
/users/authorization
delete
/users/authorization
post
/users/authorization-form
post
/users/authorization-form/{bank_id}
get
/users/authorizations
post
Create/Update a single stripe connected bank account. Does not support new Finance funds.
delete
Deletes a connected bank account.
get
/users/banks
post
/users/banks
get
/users/banks/{id}
patch
/users/banks/{id}
post
/users/fund-steps
get
/users/gateways
post
/users/gateways
delete
/users/gateways/{id}
get
/users/logout
get
Returns currently logged in user.
get
Returns currently logged in user with minimal info.
get
/users/todays-activities
get
/users/{id}
patch
/users/{id}
get
/users/{id}/owner-report-card
get
/users/{user_id}/bundles
post
/users/{user_id}/bundles
delete
/users/{user_id}/bundles
get
/users/{user_id}/cards
post
/users/{user_id}/cards
delete
/users/{user_id}/cards/{card_id}
patch
/users/{user_id}/cards/{card_id}
get
Returns a list of validations in the system. The data returned is a public-facing subset of the internal data.
get
/wishlists
post
/wishlists
get
/wishlists-recently-saved
post
/wishlists/change-wishlist
get
/wishlists/{wishlist_id}
delete
/wishlists/{wishlist_id}
patch
/wishlists/{wishlist_id}
post
/wishlists/{wishlist_id}/accept-invite
put
/wishlists/{wishlist_id}/add
post
/wishlists/{wishlist_id}/remove
delete
/wishlists/{wishlist_id}/remove-user
post
/wishlists/{wishlist_id}/token