OffRide
Developers

OffRide API

Endpoints and credentials for your account.

VERSION 2026-08-03.v1394 OPERATIONSAUTH Bearer token

Authentication

Server integrations use a scoped bearer key and an explicit partner tenant. Secrets belong on your server and must never be shipped to a browser or driver device.

HEADERAuthorization: Bearer …

Partner credential created from Partner settings.

HEADERX-OffRide-Tenant: partner-slug

The tenant boundary for the request.

Available products

DemandRequest transportation and follow fulfillment through capability-scoped access.9 possible capabilities
SupplyProvide transportation through capability-scoped supply and dispatch access.21 possible capabilities

Your endpoints

GET/api/v1/demand/capabilities

Lists the Demand API operations currently implemented.demand

POST/api/v1/demand/requests/preview

Validates and normalizes a request without creating operational state.demand · demand.requests.preview

POST/api/v1/demand/requests

Creates an idempotent persistent ride request inside the authenticated Demand tenant.demand · demand.requests.write

GET/api/v1/demand/requests

Lists ride requests created by the authenticated Demand tenant.demand · demand.requests.read

GET/api/v1/demand/requests/{requestId}

Returns one ride request, fulfillment state, assignment, offers, and lifecycle for the authenticated Demand tenant.demand · demand.requests.read

PATCH/api/v1/demand/requests/{requestId}

Updates an unassigned Demand ride request in the authenticated tenant. Pending supply offers are withdrawn so the updated trip can be dispatched safely.demand · demand.requests.write

DELETE/api/v1/demand/requests/{requestId}

Cancels an unassigned Demand ride request in the authenticated tenant. The ride remains available in history with its lifecycle evidence intact.demand · demand.requests.write

GET/api/v1/demand/stream

Streams tenant-scoped ride state, authorized assigned-driver location, and durable operational notifications.demand · demand.fulfillment.read

GET/api/v1/demand/notifications

Lists durable ride notifications for the authenticated Demand tenant.demand · demand.fulfillment.read

PATCH/api/v1/demand/notifications/{notificationId}

Marks one tenant-scoped operational notification as read.demand · demand.fulfillment.read

GET/api/v1/supply/capabilities

Lists the Supply API operations currently implemented.supply

GET/api/v1/supply/offers

Lists fleet-addressed offers and direct offers for drivers affiliated with the authenticated fleet.supply · supply.assignments.read

POST/api/v1/supply/driver/me/location

Idempotently records a versioned location sample for the signed-in driver while they are online.supply · trip.location.write

GET/api/v1/events/capabilities

Lists event topics and the webhook or WebSocket transports planned for each topic. This discovery operation does not create a subscription.events

GET/api/v1/supply/organization

Returns the supply organization scoped by the authenticated tenant.supply · supply.organization.read

GET/api/v1/supply/fee-policy

Reads the fees on rides this fleet supplies: its fleet override over the platform default. Rates in basis points, add-on rules, and the policy versions they come from.supply · supply.organization.read

GET/api/v1/supply/drivers

Lists active driver relationships in the authenticated fleet, including employee or contractor relationship, exclusivity, compensation basis, and primary fleet vehicle assignment.supply · supply.drivers.read

POST/api/v1/supply/drivers

Adds an existing or new OffRide driver to the authenticated fleet with an explicit employee or contractor relationship, exclusivity policy, compensation basis, and optional primary vehicle, without taking ownership of the person's account.supply · supply.drivers.write

PATCH/api/v1/supply/drivers/{driverId}

Updates fleet-managed driver contact, employee or contractor relationship, exclusivity, hourly or per-ride compensation, and primary vehicle assignment.supply · supply.drivers.write

DELETE/api/v1/supply/drivers/{driverId}

Ends a driver's relationship with the authenticated fleet while preserving their OffRide identity and other affiliations.supply · supply.drivers.write

GET/api/v1/supply/drivers/{driverId}/availability

Returns a fleet driver's effective availability, deterministic precedence, active schedule rules, and persisted audit history.supply · supply.drivers.read

PATCH/api/v1/supply/drivers/{driverId}/availability

Sets a fleet driver's immediate baseline supply scope and IANA time zone with an auditable reason.supply · supply.drivers.write

POST/api/v1/supply/drivers/{driverId}/availability/rules

Creates a one-time or weekly fleet-scoped availability rule with an effective window and audit reason.supply · supply.drivers.write

PATCH/api/v1/supply/drivers/{driverId}/availability/rules/{ruleId}

Replaces one active schedule rule while retaining the superseded rule and its audit history.supply · supply.drivers.write

DELETE/api/v1/supply/drivers/{driverId}/availability/rules/{ruleId}

Soft-deletes one active driver availability rule while retaining its persisted audit history.supply · supply.drivers.write

GET/api/v1/supply/vehicles

Lists the authenticated fleet's active, maintenance, and retired vehicles and capacity details.supply · supply.vehicles.read

POST/api/v1/supply/vehicles

Registers a vehicle and its service class, capacity, accessibility, and operating state in the authenticated fleet.supply · supply.vehicles.write

PATCH/api/v1/supply/vehicles/{vehicleId}

Updates one vehicle owned by the authenticated fleet.supply · supply.vehicles.write

DELETE/api/v1/supply/vehicles/{vehicleId}

Retires a vehicle and clears its active fleet assignments while preserving ride history.supply · supply.vehicles.write

GET/api/v1/supply/tracking/drivers

Returns current location and freshness for drivers whose location was shared inside the authenticated fleet workspace. Driver roster access is also required.supply · trip.tracking.read

POST/api/v1/supply/offers/{offerId}/response

Accepts or rejects an unexpired marketplace offer already bound to one eligible driver and vehicle. The responding actor cannot replace that supply unit.supply · trip.lifecycle.write

POST/api/v1/supply/rides/{rideId}/assignment

Assigns an eligible driver and vehicle to an internal-fleet ride owned by the active organization. Marketplace rides cannot use this operation.supply · supply.assignments.write

GET/api/v1/demand/requests/{requestId}/cancellation

Lists the reasons a demand partner may give for cancelling a ride.demand · demand.requests.write

POST/api/v1/demand/requests/{requestId}/cancellation

Cancels a ride with a stated reason, including one already assigned. The driver is told and released, and the reason decides compensation.demand · demand.requests.write

GET/api/v1/fleet/capabilities

Compatibility namespace retained while consumers migrate to Demand and Supply.compatibility

POST/api/v1/fleet/requests/preview

Deprecated alias for the Demand ride request preview operation.compatibility · demand.requests.preview

GET/api/v1/events/webhooks

Lists the authenticated partner's webhook endpoints. Signing secrets are never listed.events · events.webhooks.read

POST/api/v1/events/webhooks

Registers a webhook endpoint for ride and offer topics and returns its signing secret once. Deliveries are signed with the Standard Webhooks scheme. ride.cancelled carries data.cancellation (RideCancellation): who cancelled (demand, operator, rider, driver or system) and the reason code and label.events · events.webhooks.write

DELETE/api/v1/events/webhooks/{webhookId}

Disables a webhook endpoint and stops its undelivered events.events · events.webhooks.write

GET/api/v1/events/webhooks/{webhookId}/deliveries

Lists recent deliveries for one webhook endpoint with status, attempts, and the last response.events · events.webhooks.read

POST/api/v1/events/webhooks/{webhookId}/deliveries/{deliveryId}/replay

Queues one delivery to be sent again with a fresh retry budget.events · events.webhooks.write

POST/api/v1/demand/bookings

Creates an idempotent multi-leg booking. Each leg becomes one ride carrying its stops, flight, service type, extras, and meet-and-greet; missing coordinates are geocoded server-side when a geocoder is configured. A shared_seat leg whose seat hold lapsed or was released is refused with 410 seats_expired (hold again); other problems are 422 booking_unplaceable with details. An optional partner block records who booked and their cut (see docs/partner-integration.md, Demand partners): a partner booking for its client, or a system mirroring a partner's booking with partner.ref and its own economics. An optional statedPrice (BookingStatedPrice; needs the statedPrice entitlement, 403 not_entitled otherwise) states the price the partner charged: each leg's ride is offered and settled on its stated amount, and the booking's price.source is partner_stated. A booking is priced by a quote or a stated price, not both.demand · demand.requests.write

GET/api/v1/demand/bookings/{bookingId}

Reads a booking and the current state of each leg. price (BookingPrice) is null unless the booking was bought from a quote (source quote) or the partner stated its price (source partner_stated, with each leg's amount and the breakdown).demand · demand.requests.read

PATCH/api/v1/demand/bookings/{bookingId}

Changes the details of a booking's existing legs (times, addresses, party, stops, flight, extras). Reports per leg whether it was updated, unchanged, or refused because a driver already holds it. A partner block changes the payer or carries the sending system's commissionStatus and economics. A statedPrice (statedPrice entitlement) restates the price: legs not yet taken are offered again at the new pay, legs a driver holds keep the driver and settle on the new amount, finished legs keep their settlement. Left out, the stated price stays. A booking bought from a quote can't be restated (422).demand · demand.requests.write

PUT/api/v1/demand/bookings/{bookingId}/payment-state

Records what the customer has paid (paid, deposit, cash_at_pickup, call_to_confirm, refunded) so dispatch knows what to collect.demand · demand.requests.write

POST/api/v1/demand/bookings/{bookingId}/cancellation

Cancels a whole booking, or chosen legs, with one reason. Finished legs are reported rather than failed, so the call is safe to repeat.demand · demand.requests.write

GET/api/v1/demand/rate-card

Reads the partner's rate card in force: products, pricing components, rules, coupons, fees.demand · demand.requests.read

GET/api/v1/demand/fee-policy

Reads the fees this partner pays now: on marketplace rides it books, and on rides its own fleet drives. Rates in basis points, add-on rules, and the policy versions they come from.demand · demand.requests.read

GET/api/v1/demand/entitlements

Reads what this partner is enabled to do with prices (own rates, coupons, price adjustments, markup and its pay mode, stated prices) and the markup it has set.demand · demand.requests.read

PUT/api/v1/demand/markup

Sets this partner's margin on the platform's price, { markupBps }. Needs the markup entitlement (403 not_entitled otherwise) and stays within the operator's cap. pass_through rides pay the driver on the marked-up price; partner_only rides on the base price.demand · demand.requests.write

PUT/api/v1/demand/rate-card

Publishes a new version of the partner's rate card. Earlier quotes keep the version they were priced from. With ?dryRun=true (or "dryRun": true in the body) nothing is saved: 200 with the parsed card, diff.changes against the card in force ([{ path, change: added|removed|changed, before, after }]), nextVersion, publishable and blockedBy (the entitlement it still needs). An invalid card is 400 invalid_rate_card either way.demand · demand.requests.write

POST/api/v1/demand/quotes

Prices a trip (1-10 legs) for every product on the partner's rate card, with line items, rules, coupon, fees and tax, and holds the price until the quote expires. Legs may name their ferry crossings and tolls; the card prices them as required add-ons (line items with kind ferry or toll, parts, required: true; addOnTotal), which no rule or coupon reduces. confirmation is set when a ferry trip should be confirmed by phone. An unknown toll segment is a 409 unknown_toll_segment.demand · demand.requests.preview

GET/api/v1/demand/quotes/{quoteId}

Reads a quote and whether its price still holds.demand · demand.requests.preview

GET/api/v1/demand/policies/{kind}

Reads one of the partner's operating policies (sales: lead time, window, hours, own-fleet caps, overflow; accountability: confirmation calls, leave-now texts, late alerts, dispatch phones), with defaults filled in.demand · demand.requests.read

PUT/api/v1/demand/policies/{kind}

Sets one of the partner's operating policies; unset fields keep their defaults.demand · demand.requests.write

GET/api/v1/supply/service-lines

Lists the partner's scheduled shared-service lines.supply · supply.organization.read

PUT/api/v1/supply/service-lines

Creates or replaces a scheduled shared-service line (endpoint rules, per-seat pricing, weekly schedule, capacity, visibility), keyed by slug.supply · supply.organization.write

GET/api/v1/supply/service-lines/{lineId}/departures

Lists a line's departures between two instants (from, to; up to 92 days) with status, capacity, and seats sold, held and left.supply · supply.organization.read

POST/api/v1/supply/service-lines/{lineId}/departures

Adds departures. With { departureAt } (optional seatCapacity, bagCapacity) it creates that one departure by hand: 201 created, 200 if it already existed. With { from, to } it creates what the weekly schedule implies between two dates. Both are idempotent. Lines with a scheduleHorizonDays above 0 (default 60) are also kept scheduled that far ahead automatically; 0 turns that off.supply · supply.organization.write

GET/api/v1/supply/departures/{departureId}/manifest

Lists the confirmed parties on a departure, grouped by flight.supply · supply.organization.read

POST/api/v1/supply/departures/{departureId}/dispatch

Puts a vehicle and driver on a departure; both must belong to the operator, the vehicle must seat everyone confirmed, and neither may be busy in that window.supply · supply.assignments.write

PUT/api/v1/supply/departures/{departureId}/status

Opens or closes sales, marks a departure departed (it must be dispatched) or completed, or cancels it with its seats. Seat rides follow: departed picks them up, completed completes them, cancelled cancels them. Partners with seats get departure.* events.supply · supply.assignments.write

PUT/api/v1/supply/service-lines/{lineId}/dispatch-policy

Sets how a line's runs find a driver: policy marketplace (default; every eligible driver, first to accept takes it), fleet_first (the operator's own drivers for fleetFirstWindowMinutes, then the marketplace), fleet_only (own drivers only) or direct (no offers); driverPayCents (runs are offered only once set) and offerLeadMinutes (how long before departure a run goes out on its own).supply · supply.organization.write

GET/api/v1/supply/departures/{departureId}/offers

Lists everything offered for a run: its policy and round, who was offered it, and what they did.supply · supply.assignments.read

POST/api/v1/supply/departures/{departureId}/offers

Offers a run now under its line's dispatch policy, optionally with { payCents } for this run. Idempotent while its offers are out. Sends departure.offered.supply · supply.assignments.write

GET/api/v1/supply/departure-offers

Lists run offers this fleet answers for its drivers.supply · supply.assignments.read

POST/api/v1/supply/departure-offers/{offerId}/response

Accepts or passes a run offer ({ response: accept | reject }). The first acceptance is dispatched with the same capacity and clash checks as a direct dispatch and sends departure.dispatched; a later one gets 409.supply · trip.lifecycle.write

POST/api/v1/demand/seats/search

Finds departures a party can still hold, between two times, on the partner's own lines and marketplace lines, with seatsLeft, bagsLeft and price. Departures past their boarding cut-off are left out.demand · demand.requests.preview

POST/api/v1/demand/seats/holds

Holds seats on a departure while the customer pays: holdMinutes, 1 to 35 (default 15). Capacity counts confirmed seats and live holds under a lock. Send an Idempotency-Key header: a retry returns the same hold (200, replayed), and the same key for a different hold is refused (409).demand · demand.requests.write

POST/api/v1/demand/seats/holds/{holdId}/extension

Extends a live hold while a checkout runs longer: it lasts holdMinutes (1 to 35, default 15) from now, never less than before, never past boarding, and at most two hours from when it was made. A lapsed or released hold can't be extended (410); a hold confirmed meanwhile is returned as confirmed.demand · demand.requests.write

POST/api/v1/demand/seats/holds/{holdId}/confirmation

Confirms held seats with the rider's details.demand · demand.requests.write

DELETE/api/v1/demand/seats/holds/{holdId}

Releases a hold. Confirmed seats are refused (409 seats_conflict): cancel the shared_seat ride they were booked as, or, for seats confirmed without a booking, send ?cancelConfirmed=true. Releasing a released or lapsed hold is a no-op.demand · demand.requests.write

POST/api/v1/demand/availability

Answers, per service class and leg, whether a trip can be sold and who would fulfil it (own fleet or marketplace overflow), from the sales policy and live supply.demand · demand.requests.preview

GET/api/v1/supply/roster

Reads the supply partner's drivers and vehicles with the partner's own references.supply · supply.drivers.read

PUT/api/v1/supply/roster

Reconciles the partner's drivers and vehicles, keyed by its own references. Also requires supply.vehicles.write. dryRun reports what would change, which is the roster parity report; mode full retires what the partner no longer lists.supply · supply.drivers.write

GET/api/v1/supply/driver-invitations

Lists the fleet's driver invitations and their status.supply · supply.drivers.read

POST/api/v1/supply/driver-invitations

Invites a driver by mobile number with starting ride access and the fleet vehicles they may drive. The driver joins with their own account and accepts their own rides.supply · supply.drivers.write

DELETE/api/v1/supply/driver-invitations/{invitationId}

Withdraws an invitation that has not been accepted.supply · supply.drivers.write

PUT/api/v1/supply/drivers/{driverId}/ride-access

Sets which rides a fleet driver can take (fleet, marketplace, both, or paused) and which fleet vehicles they may drive. It never accepts a ride for the driver.supply · supply.drivers.write

GET/api/v1/demand/pickup-spots

Lists the organization's saved pickup spots.demand · demand.requests.read

POST/api/v1/demand/pickup-spots

Saves a pickup spot with directions for drivers. Owners and admins only.demand · demand.requests.write

DELETE/api/v1/demand/pickup-spots/{spotId}

Archives a saved pickup spot. Owners and admins only.demand · demand.requests.write

GET/api/v1/demand/partner/enrolment

This partner's enrolment: status, effective terms (commission, who funds it, billing) and the current partner terms text to accept.demand · demand.requests.read

GET/api/v1/demand/partner/clients

Lists the partner's saved clients (?search=, ?includeArchived=true).demand · demand.requests.read

POST/api/v1/demand/partner/clients

Saves a client ({ name or firstName and lastName, email and/or phone, notes? }). The same email updates the client already saved.demand · demand.requests.write

GET/api/v1/demand/partner/clients/{clientId}

Reads one saved client.demand · demand.requests.read

PATCH/api/v1/demand/partner/clients/{clientId}

Changes the fields sent.demand · demand.requests.write

DELETE/api/v1/demand/partner/clients/{clientId}

Archives the client. Bookings made for it keep pointing at it.demand · demand.requests.write

GET/api/v1/demand/partner/team

Lists the partner's owners, admins and bookers (its organization memberships).demand · demand.requests.read

POST/api/v1/demand/partner/terms/acceptance

Accepts the platform's current partner terms ({ version }). A signed-in person must be an owner or admin. Refused (409) if the version isn't the current one.demand · demand.requests.write

GET/api/v1/demand/partner/bookings

Bookings this partner arranged: client, payer, economics snapshot and commission status.demand · demand.requests.read

GET/api/v1/demand/partner/earnings

The partner's commission and markup ledger: totals by status (pending, earned, paid, voided, reversed) and every accrual and reversal line.demand · demand.requests.read

GET/api/v1/demand/bookings/{bookingId}/partner

Who booked this booking and their cut, as the asking organization may see it (the partner, or the organization that sent the booking).demand · demand.requests.read

PUT/api/v1/demand/bookings/{bookingId}/partner

Sets the booking's partner block on its own: attaches it when the booking has none, otherwise changes the payer or (from the system that sent the booking) its commissionStatus and economics, which re-runs the parity check.demand · demand.requests.write