For AI agents: visit https://karhoo.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Karhoo for Developers | Mobility Exchange API and SDK reference
HomeGuidesAPI ReferenceChangelog
HomeAPI ReferenceGuidesChangelogKarhoo.comLog InKarhoo for Developers | Mobility Exchange API and SDK reference
API Reference
HomeAPI ReferenceGuidesChangelogKarhoo.comLog In

Welcome to the Karhoo API

  • Karhoo API Explorer

5 Minutes to Book a Trip

  • Your journey starts here
  • Plan a trippost
  • Retrieve quotesget
  • Book a trippost
  • Receive confirmation

Authentication API 1.0

  • Auth
    • Get an Access Tokenpost
    • Refresh Access Tokenpost
    • Revoke Refresh Tokendel
  • Health Check
    • Check Servicesget

Identity API 1.0

  • OAuth 2.0
    • Authorize endpointget
    • Token endpointpost
    • Getting user detailsget
    • Revoking issued tokenspost
  • Token exchange
    • Authenticating with third-party tokenspost

Services API 2.0

  • Services
    • Retrieve Services Listget
    • Request Servicespost
  • Healthcheck
    • Check Servicesget

Quotes API 2.0

  • Quotes
    • Request Quotespost
    • Retrieve Quote Listget
  • Coverage
    • Check Coverageget
  • Healthcheck
    • Check Servicesget

Bookings API 1.0

  • Bookings
    • Book a Trippost
    • Book a Trip only if the preauthorisation of the payment_nonce is successfulpost
    • Get Booking Detailsget
    • Cancel a Bookingpost
    • Retrieve the estimated cancellation feeget
    • Get Booking Historyget
    • Get Booking Statusget
    • Get Position of a Tripget
    • Search Booking Historypost
    • Get Trips for an Organisationget
    • Get Trips for a Fleetget
    • Follow a Bookingget
    • Cancel a Booking given a follow linkpost
    • Get cancellation fee for a Booking given a follow codeget
  • Healthcheck
    • Check Servicesget

Fares API 1.0

  • final-fare
    • Get final fare from trip idget
  • supplier-details
    • Get supplier details related to tripget
  • documents
    • Get trip document PDFget

Webhooks API 1.0

  • Webhooks
    • Register webhook endpointpost
    • Returns active subscriptions for the userget
    • Removes active subscriptions or delete by ID.del

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 Karhoopost
  • DMS Trip Status Push to Karhoopost
  • DMS Trip document push to Karhoopost
  • [Push] Trip Status
  • [Push] Trip Document
  • [DMS Endpoint] Receive New Trips
    • DMS hosted API endpoint for receiving Karhoo trip bookingspost
  • [DMS Endpoint] Provide Trip Details
    • DMS Hosted endpoint to respond to Karhoo Trip Detail requestsget
  • [DMS Endpoint] Cancel Trip
    • DMS Hosted endpoint to respond to Karhoo Trip Cancellation requestsdel
  • [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 requestspost
  • [DMS Endpoint] ETA Request
    • DMS hosted API endpoint for responding to ETA requestspost
  • [DMS Endpoint] Availability Request
    • Karhoo Availability Request to DMSpost
  • Healthcheck
    • Health check endpointget

Loyalty API

  • Loyalty
    • Get loyalty exchange ratesget
    • Get user loyalty points balanceget
    • Burn loyalty pointspost
    • Refund loyalty pointspost
  • Healthcheck
    • Check the health of your APIget

Onboarding API

  • Fleet External Accounts
    • List fleet's external accountsget
    • Create a new fleet external accountpost

Operations API 1.0

  • trips
    • Provides an API for triggering a new resync with the DMSpost
    • Add review for existing trippost
  • quotes
    • Get raw dms payloadsget

Payments API 3.0

  • Loyalty
    • Loyalty points user's balanceget
    • Loyalty points conversion ratesget

Connect API 1.0

  • Order
    • Create a order for delivery (with callbacks)put

Support API 1.0

  • SupportTickets
    • List support ticketsget
    • Get a support ticket by idget
    • Add comment to a support ticket (reply to ticket)post
    • Create a trip support ticket for demand partner trip IDpost
    • List support tickets for the tripget
    • Create a trip support ticketpost
    • Upload an attachmentpost

Partners API 1.0

  • Dispatch Partners
    • Discovers supply partners registered within given DMSget
    • Imports the DMS-registered supply partnerpost
    • Manages imported DMS-registered supply partnerput
    • Disables the DMS-registered supply partnerdel
Powered by 
  1. Webhooks API 1.0

Webhooks

👍

Learn more using our how-to guide

How to process Karhoo Web hooks

Updated over 2 years ago


Updated over 2 years ago