API reference
Every endpoint
54 endpoints in 11 areas. Base URL https://engine-production-0004.up.railway.app/api/v1. The same description is available as an OpenAPI file you can import into Postman, Insomnia or a code generator.
Getting around
The airports where cars are collected and returned, and the terms to show your customers.
Rentals
Search cars for rent, read a car’s calendar, and list the extras and covers a customer can add.
Price a trip, book it, manage it, check the customer in, cancel it.
What customers say about a car, with its average rating. A customer reviews the car after the rental is returned (or the purchase is complete), and a review counts for that car only.
Sales
Search cars for sale, reserve one with a deposit, and follow the purchase through escrow.
Money
Your balance, every commission you earned and the payouts you received.
Events and webhooks
Your own cars
For businesses with their own cars (plan: fleet or both): add cars, photos and papers, open rental periods and list cars for sale.
- get/fleet/vehicles
- post/fleet/vehicles
- get/fleet/vehicles/{id}
- patch/fleet/vehicles/{id}
- delete/fleet/vehicles/{id}
- post/fleet/vehicles/{id}/photos
- delete/fleet/vehicles/{id}/photos/{index}
- post/fleet/vehicles/{id}/documents
- get/fleet/vehicles/{id}/availability
- post/fleet/vehicles/{id}/availability
- delete/fleet/vehicles/{id}/availability/{windowId}
- get/fleet/vehicles/{id}/listing
- post/fleet/vehicles/{id}/listing
- patch/fleet/vehicles/{id}/listing
- delete/fleet/vehicles/{id}/listing
Testing
Simulate a customer paying, collecting and returning a car, with a test key.