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
Upload an attachment
Search
JUMP TO
Welcome to the Karhoo API
Karhoo API Explorer
5 Minutes to Book a Trip
Your journey starts here
Plan a trip
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
Identity API 1.0
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
Services API 2.0
Services
Retrieve Services List
get
Request Services
post
Healthcheck
Check Services
get
Quotes API 2.0
Quotes
Request Quotes
post
Retrieve Quote List
get
Coverage
Check Coverage
get
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
Get cancellation fee for a Booking given a follow code
get
Healthcheck
Check Services
get
Fares API 1.0
final-fare
Get final fare from trip id
get
supplier-details
Get supplier details related to trip
get
documents
Get trip document PDF
get
Webhooks API 1.0
Webhooks
Register webhook endpoint
post
Returns active subscriptions for the user
get
Removes active subscriptions or delete by ID.
delete
Network SDK
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
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
DMS Trip document push to Karhoo
post
[Push] Trip Status
[Push] Trip Document
[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
Fleet External Accounts
List fleet's external accounts
get
Create a new fleet external account
post
Operations API 1.0
trips
Provides an API for triggering a new resync with the DMS
post
Add review for existing trip
post
quotes
Get raw dms payloads
get
Payments API 3.0
Loyalty
Loyalty points user's balance
get
Loyalty points conversion rates
get
Connect API 1.0
Order
Create a order for delivery (with callbacks)
put
Support API 1.0
SupportTickets
List support tickets
get
Get a support ticket by id
get
Add comment to a support ticket (reply to ticket)
post
Create a trip support ticket for demand partner trip ID
post
List support tickets for the trip
get
Create a trip support ticket
post
Upload an attachment
post
Partners API 1.0
Dispatch Partners
Discovers supply partners registered within given DMS
get
Imports the DMS-registered supply partner
post
Manages imported DMS-registered supply partner
put
Disables the DMS-registered supply partner
delete
Upload an attachment
post
https://rest.sandbox.karhoo.com/v1/support/upload-attachment
Language
Shell
JavaScript
Node
Java
Kotlin
RESPONSE
Click
Try It!
to start a request and see the response here!
