Jump to Content
API Reference
Home
API Reference
Guides
Changelog
Karhoo.com
Log In
API Reference
Home
API Reference
Guides
Changelog
Karhoo.com
Log In
API Reference
List support tickets
Search
These docs are for v1.0. Click to read the latest docs for v2.0.
JUMP TO
Welcome to the Karhoo API
Karhoo API Explorer
5 Minutes to Book a Trip
Your journey starts here
Plan a trip
post
Request quotes
post
Retrieve quotes
get
Book a trip
post
Receive confirmation
Authentication API 1.0
Auth
Get an Access Token
post
Refresh Access Token
post
Revoke Refresh Token
delete
Health Check
Check Services
get
OAuth 2.0 API
OAuth 2.0
Authorize endpoint
get
Token endpoint
post
Getting user details
get
Revoking issued tokens
post
Token exchange
Authenticating with third-party tokens
post
Quotes API 1.0
Quotes
Request Quotes
post
Retrieve Quote List
get
Verify quote price with DMS before booking
get
Availability
Check Availability
post
Healthcheck
Check Services
get
Bookings API 1.0
Bookings
Book a Trip
post
Book a Trip only if the preauthorisation of the payment_nonce is successful
post
Get Booking Details
get
Cancel a Booking
post
Retrieve the estimated cancellation fee
get
Get Booking History
get
Get Booking Status
get
Get Position of a Trip
get
Search Booking History
post
Get Trips for an Organisation
get
Get Trips for a Fleet
get
Follow a Booking
get
Cancel a Booking given a follow link
post
Healthcheck
Check Services
get
Fares API 1.0
final-fare
Get final fare from trip id
get
Locations API 1.0
Addresses
Address Autocomplete
post
Address Details
post
Place Details
post
Reverse geo-code
get
Healthcheck
Check Services
get
Network SDK
User Service
register
login
logout
resetPassword
currentUser
User object schemas
Auth Service
login (token)
revoke
Address Service
placeSearch
locationInfo
reverseGeocode
Address object schemas
Quotes Service
quotes
Quotes object schemas
Trip Service
book
cancel
search
trackTrip
status
Trip object schemas
Driver Tracking Service
trackDriver
Driver Tracking object schemas
UI SDK
Custom styling
Injectable components
Deeplink
Address screen
iOS implementation
Android implementation
Booking screen
iOS implementation
Android implementation
Flight Number screen
iOS implementation
Android implementation
Trip screen
iOS implementation
Android implementation
Rides screen
iOS implementation
Android implementation
Ride Details screen
iOS implementation
Android implementation
Additional Feedback screen
iOS implementation
Android implementation
Supply API 1.0
[Push] Availability
Stream fleet wide vehicle availability to Karhoo
post
DMS Trip Status Push to Karhoo
post
[Push] Trip Status
[DMS Endpoint] Receive New Trips
DMS hosted API endpoint for receiving Karhoo trip bookings
post
[DMS Endpoint] Provide Trip Details
DMS Hosted endpoint to respond to Karhoo Trip Detail requests
get
[DMS Endpoint] Cancel Trip
DMS Hosted endpoint to respond to Karhoo Trip Cancellation requests
delete
[DMS Endpoint] Update Trip
DMS Hosted API endpoint to respond to Karhoo Trip Update requests to your DMS platform.
put
[DMS Endpoint] Quote Request
DMS hosted API endpoint for responding to quote requests
post
[DMS Endpoint] ETA Request
DMS hosted API endpoint for responding to ETA requests
post
[DMS Endpoint] Availability Request
Karhoo Availability Request to DMS
post
Healthcheck
Health check endpoint
get
Loyalty API
Loyalty
Get loyalty exchange rates
get
Get user loyalty points balance
get
Burn loyalty points
post
Refund loyalty points
post
Healthcheck
Check the health of your API
get
Onboarding API 1.0
Vehicle classification
Get available vehicle types
get
Get available vehicle tags
get
Payments API 3.0
Payments
Payment providers and loyalty programmes
get
Loyalty
Loyalty points user's balance
get
Loyalty points conversion rates
get
Quotes API 2.0
Quotes
Request Quotes
post
Retrieve Quote List
get
Verify quote price with DMS before booking
get
Healthcheck
Check Services
get
Support API 1.0
SupportTickets
List support tickets
get
Gets a support ticket by id
get
Add comment to a support ticket (reply to ticket)
post
List support tickets for the trip
get
Creates a trip support ticket
post
List support tickets
get
https://example.com/v1/support/tickets
Language
Shell
JavaScript
Node
Java
Kotlin
Credentials
Bearer
JWT
Bearer
Log in to use your API keys
RESPONSE
Click
Try It!
to start a request and see the response here!
