Developers

OffRide API

Endpoints and credentials for your account.

VERSION 2026-08-03.v1335 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/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