Skip to content
Same-day windows · every order tracked live
Reference

Every endpoint, in one place.

Generated from the live Fastify route table. Paths are relative to /api/v1 unless they start with /public; authenticated routes accept a bearer token or an API key.

← GuideSandboxOpenAPI JSON354 routes from the running API
admin165 routes
GET
/admin/accounting/periods

Accounting periods

POST
/admin/accounting/periods

Accounting periods

POST
/admin/accounting/periods/{id}/close

Accounting periods id close

POST
/admin/accounting/periods/{id}/reopen

Accounting periods id reopen

GET
/admin/analytics

Analytics

GET
/admin/api-keys

Api keys

POST
/admin/api-keys

Api keys

DELETE
/admin/api-keys/{id}

Api keys id

GET
/admin/approvals

Approvals

POST
/admin/approvals/{id}/decide

Approvals id decide

GET
/admin/audit

Audit

GET
/admin/batching

Batching

GET
/admin/business

Business

POST
/admin/business

Business

POST
/admin/business/{id}/rate-cards

Business id rate cards

GET
/admin/cash

Cash

POST
/admin/cash/remittances

Cash remittances

GET
/admin/chargebacks

Chargebacks

POST
/admin/chargebacks

Chargebacks

PATCH
/admin/chargebacks/{id}

Chargebacks id

GET
/admin/churn

Churn

GET
/admin/cities

Cities

GET
/admin/cities/{id}/launch

Cities id launch

POST
/admin/cities/{id}/launch

Cities id launch

PATCH
/admin/cities/{id}/launch-checks

Cities id launch checks

POST
/admin/cities/{id}/pause

Cities id pause

GET
/admin/claims

Claims

POST
/admin/claims/{id}/status

Claims id status

GET
/admin/cms

Cms

POST
/admin/cms

Cms

POST
/admin/cms/faqs

Cms faqs

PATCH
/admin/cms/faqs/{id}

Cms faqs id

GET
/admin/compliance

Compliance

POST
/admin/compliance

Compliance

PATCH
/admin/compliance/{id}

Compliance id

GET
/admin/credit

Credit

PATCH
/admin/credit/{businessId}

Credit businessId

POST
/admin/credit/{businessId}/dun

Credit businessId dun

GET
/admin/crm/campaigns

Crm campaigns

POST
/admin/crm/campaigns

Crm campaigns

POST
/admin/crm/campaigns/{id}/send

Crm campaigns id send

GET
/admin/crm/leads

Crm leads

POST
/admin/crm/leads

Crm leads

PATCH
/admin/crm/leads/{id}

Crm leads id

GET
/admin/crm/segments

Crm segments

POST
/admin/crm/segments

Crm segments

PATCH
/admin/crm/segments/{id}

Crm segments id

GET
/admin/crm/targets

Crm targets

POST
/admin/crm/targets

Crm targets

GET
/admin/customers

Customers

GET
/admin/disputes

Disputes

POST
/admin/disputes/{id}/decide

Disputes id decide

GET
/admin/documents

Documents

POST
/admin/documents/{id}/review

Documents id review

GET
/admin/drivers

Drivers

PATCH
/admin/drivers/{id}

Drivers id

GET
/admin/esg

Esg

GET
/admin/esg/export.csv

Esg export.csv

GET
/admin/exceptions

Exceptions

POST
/admin/files/purge

Files purge

GET
/admin/finance/summary

Finance summary

PATCH
/admin/flags/{key}

Flags key

GET
/admin/fleets

Fleets

POST
/admin/fleets

Fleets

POST
/admin/fleets/{id}/settlements

Fleets id settlements

GET
/admin/forecast

Forecast

GET
/admin/fx

Fx

POST
/admin/fx

Fx

GET
/admin/growth/attribution

Growth attribution

GET
/admin/growth/experiments

Growth experiments

POST
/admin/growth/experiments

Growth experiments

PATCH
/admin/growth/experiments/{id}

Growth experiments id

GET
/admin/growth/lifecycle

Growth lifecycle

POST
/admin/growth/lifecycle

Growth lifecycle

PATCH
/admin/growth/lifecycle/{id}

Growth lifecycle id

POST
/admin/growth/lifecycle/run

Growth lifecycle run

GET
/admin/incentives

Incentives

POST
/admin/incentives

Incentives

PATCH
/admin/incentives/{id}

Incentives id

POST
/admin/incentives/{id}/award/{driverId}

Incentives id award driverId

GET
/admin/integrations

Integrations

POST
/admin/integrations

Integrations

PATCH
/admin/integrations/{key}

Integrations key

POST
/admin/integrations/{key}/test

Integrations key test

GET
/admin/integrations/catalog

Integrations catalog

GET
/admin/intelligence/eta

Intelligence eta

POST
/admin/intelligence/eta/approve

Intelligence eta approve

GET
/admin/intelligence/eta/mode

Intelligence eta mode

PATCH
/admin/intelligence/eta/mode

Intelligence eta mode

GET
/admin/invoices

Invoices

GET
/admin/jobs

Jobs

POST
/admin/jobs/{id}/cancel

Jobs id cancel

POST
/admin/jobs/{id}/retry

Jobs id retry

GET
/admin/knowledge

Knowledge

POST
/admin/knowledge

Knowledge

PATCH
/admin/knowledge/{id}

Knowledge id

GET
/admin/kyc

Kyc

POST
/admin/kyc/{id}/review

Kyc id review

GET
/admin/ledger/journals

Ledger journals

GET
/admin/ledger/trial-balance

Ledger trial balance

GET
/admin/live

Live

GET
/admin/markets

Markets

POST
/admin/markets

Markets

POST
/admin/markets/{code}/tax-rules

Markets code tax rules

GET
/admin/metrics/daily

Metrics daily

POST
/admin/metrics/rollup

Metrics rollup

GET
/admin/notifications

Notifications

PATCH
/admin/orders/{id}/cargo

Orders id cargo

GET
/admin/orders/{id}/evidence-pack

Orders id evidence pack

GET
/admin/outbox

Outbox

POST
/admin/outbox/{id}/retry

Outbox id retry

GET
/admin/overview

Overview

GET
/admin/payment-routes

Payment routes

PUT
/admin/payment-routes

Payment routes

GET
/admin/payments

Payments

GET
/admin/payouts

Payouts

GET
/admin/payouts/batches

Payouts batches

POST
/admin/payouts/batches

Payouts batches

POST
/admin/payouts/batches/{id}/{action}

Payouts batches id action

GET
/admin/pricing

Pricing

PATCH
/admin/pricing/rules/{id}

Pricing rules id

PATCH
/admin/pricing/surges/{id}

Pricing surges id

GET
/admin/promos

Promos

POST
/admin/promos

Promos

PATCH
/admin/promos/{id}

Promos id

GET
/admin/reconciliation

Reconciliation

GET
/admin/refunds

Refunds

GET
/admin/reports/finance

Reports finance

GET
/admin/returns

Returns

POST
/admin/returns/{id}/decide

Returns id decide

GET
/admin/reviews

Reviews

POST
/admin/reviews/{id}/status

Reviews id status

GET
/admin/risk/cases

Risk cases

PATCH
/admin/risk/cases/{id}

Risk cases id

POST
/admin/risk/evaluate

Risk evaluate

GET
/admin/risk/rules

Risk rules

POST
/admin/risk/rules

Risk rules

GET
/admin/roles

Roles

GET
/admin/search

Search

GET
/admin/security/events

Security events

PATCH
/admin/security/events/{id}

Security events id

GET
/admin/settings

Settings

PUT
/admin/settings/{key}

Settings key

GET
/admin/settlements

Settlements

GET
/admin/sla

Sla

POST
/admin/sla/policies

Sla policies

POST
/admin/sla/sweep

Sla sweep

GET
/admin/sso/connections

Sso connections

POST
/admin/sso/connections

Sso connections

PATCH
/admin/sso/connections/{id}

Sso connections id

POST
/admin/sso/discover

Sso discover

GET
/admin/supply

Supply

POST
/admin/supply/shifts

Supply shifts

GET
/admin/users

Users

PUT
/admin/users/{id}/roles

Users id roles

PATCH
/admin/users/{id}/status

Users id status

GET
/admin/vehicles

Vehicles

GET
/admin/wallets

Wallets

GET
/admin/weather

Weather

POST
/admin/weather

Weather

GET
/admin/webhook-deliveries

Webhook deliveries

POST
/admin/webhook-deliveries/{id}/replay

Webhook deliveries id replay

GET
/admin/webhooks

Webhooks

POST
/admin/webhooks

Webhooks

POST
/admin/webhooks/{id}/test

Webhooks id test

auth19 routes
POST
/auth/2fa/disable

2fa disable

POST
/auth/2fa/setup

2fa setup

GET
/auth/2fa/status

2fa status

POST
/auth/2fa/verify

2fa verify

POST
/auth/login

Login

POST
/auth/logout

Logout

GET
/auth/me

Me

POST
/auth/otp/request

Otp request

POST
/auth/otp/verify

Otp verify

POST
/auth/refresh

Refresh

POST
/auth/register

Register

GET
/auth/sessions

Sessions

DELETE
/auth/sessions/{id}

Sessions id

POST
/auth/sso/{key}/acs

Sso key acs

GET
/auth/sso/{key}/start

Sso key start

GET
/auth/sso/discover

Sso discover

POST
/auth/sso/exchange

Sso exchange

POST
/auth/step-up/request

Step up request

POST
/auth/step-up/verify

Step up verify

business31 routes
GET
/business/analytics

Analytics

GET
/business/api-keys

Api keys

POST
/business/api-keys

Api keys

GET
/business/approval-rules

Approval rules

POST
/business/approval-rules

Approval rules

GET
/business/approvals

Approvals

GET
/business/cost-centres

Cost centres

POST
/business/cost-centres

Cost centres

GET
/business/invoices

Invoices

GET
/business/me

Me

POST
/business/members

Members

GET
/business/orders

Orders

POST
/business/orders

Orders

POST
/business/orders/{id}/approve

Orders id approve

POST
/business/orders/{id}/reject

Orders id reject

POST
/business/orders/bulk

Orders bulk

GET
/business/rate-cards

Rate cards

GET
/business/recipients

Recipients

POST
/business/recipients

Recipients

GET
/business/recurring

Recurring

POST
/business/recurring

Recurring

PATCH
/business/recurring/{id}

Recurring id

POST
/business/recurring/{id}/blackouts

Recurring id blackouts

DELETE
/business/recurring/{id}/blackouts/{date}

Recurring id blackouts date

GET
/business/statements

Statements

GET
/business/summary

Summary

GET
/business/webhooks

Webhooks

POST
/business/webhooks

Webhooks

DELETE
/business/webhooks/{id}

Webhooks id

GET
/business/webhooks/{id}/deliveries

Webhooks id deliveries

POST
/business/webhooks/{id}/replay

Webhooks id replay

cities2 routes
GET
/cities

Cities

GET
/cities/{slug}/vehicles

Slug vehicles

demo1 routes
GET
/demo/accounts

Accounts

devices2 routes
POST
/devices/push-token

Push token

DELETE
/devices/push-token

Push token

disputes1 routes
POST
/disputes

Disputes

driver33 routes
GET
/driver/cash

Cash

GET
/driver/documents

Documents

POST
/driver/documents

Documents

GET
/driver/earnings

Earnings

GET
/driver/expenses

Expenses

POST
/driver/expenses

Expenses

GET
/driver/history

History

GET
/driver/incentives

Incentives

GET
/driver/incidents

Incidents

POST
/driver/incidents

Incidents

POST
/driver/location

Location

GET
/driver/me

Me

GET
/driver/offers

Offers

POST
/driver/offers/{id}/accept

Offers id accept

POST
/driver/offers/{id}/reject

Offers id reject

POST
/driver/online

Online

GET
/driver/orders

Orders

POST
/driver/orders/{id}/arrive

Orders id arrive

POST
/driver/orders/{id}/custody

Orders id custody

POST
/driver/orders/{id}/deliver

Orders id deliver

POST
/driver/orders/{id}/fail

Orders id fail

POST
/driver/orders/{id}/pickup

Orders id pickup

POST
/driver/orders/{id}/stops/{sequence}/complete

Orders id stops sequence complete

POST
/driver/orders/{id}/temperature

Orders id temperature

GET
/driver/payout-account

Payout account

POST
/driver/payout-account

Payout account

POST
/driver/payouts

Payouts

GET
/driver/performance

Performance

GET
/driver/preferences

Preferences

PATCH
/driver/preferences

Preferences

GET
/driver/training

Training

POST
/driver/training/{key}/complete

Training key complete

GET
/driver/wallet

Wallet

experiments2 routes
POST
/experiments/{key}/convert

Key convert

POST
/experiments/{key}/expose

Key expose

files3 routes
POST
/files

Files

GET
/files/{id}

Id

GET
/files/{id}/content

Id content

flags1 routes
GET
/flags

Flags

fleet19 routes
GET
/fleet/assignments

Assignments

GET
/fleet/documents

Documents

GET
/fleet/drivers

Drivers

POST
/fleet/drivers

Drivers

PATCH
/fleet/drivers/{id}/status

Drivers id status

GET
/fleet/earnings

Earnings

GET
/fleet/live

Live

GET
/fleet/me

Me

GET
/fleet/orders

Orders

POST
/fleet/orders/{id}/assign

Orders id assign

GET
/fleet/overview

Overview

GET
/fleet/profile

Profile

PATCH
/fleet/profile

Profile

GET
/fleet/reports

Reports

GET
/fleet/settlements

Settlements

GET
/fleet/vehicle-types

Vehicle types

GET
/fleet/vehicles

Vehicles

POST
/fleet/vehicles

Vehicles

PATCH
/fleet/vehicles/{id}

Vehicles id

growth1 routes
POST
/growth/attribution

Attribution

health2 routes
GET
/health

Health

GET
/health/ready

Ready

invoices2 routes
GET
/invoices

Invoices

GET
/invoices/{id}

Id

kyc2 routes
GET
/kyc/me

Me

POST
/kyc/submissions

Submissions

loyalty2 routes
GET
/loyalty/me

Me

POST
/loyalty/redeem

Redeem

me17 routes
GET
/me/addresses

Addresses

POST
/me/addresses

Addresses

PATCH
/me/addresses/{id}

Addresses id

DELETE
/me/addresses/{id}

Addresses id

GET
/me/business-upgrade

Business upgrade

POST
/me/business-upgrade

Business upgrade

POST
/me/consents

Consents

POST
/me/erasure

Erasure

GET
/me/export

Export

GET
/me/notification-preferences

Notification preferences

PATCH
/me/notification-preferences

Notification preferences

PATCH
/me/profile

Profile

GET
/me/recipients

Recipients

POST
/me/recipients

Recipients

DELETE
/me/recipients/{id}

Recipients id

GET
/me/referrals

Referrals

POST
/me/referrals/redeem

Referrals redeem

notifications3 routes
GET
/notifications

Notifications

POST
/notifications/{id}/read

Id read

POST
/notifications/read-all

Read all

orders23 routes
GET
/orders

Orders

POST
/orders

Orders

GET
/orders/{id}

Id

POST
/orders/{id}/assign

Id assign

GET
/orders/{id}/breadcrumbs

Id breadcrumbs

POST
/orders/{id}/cancel

Id cancel

GET
/orders/{id}/cancel-preview

Id cancel preview

GET
/orders/{id}/custody

Id custody

POST
/orders/{id}/dispatch

Id dispatch

POST
/orders/{id}/invoice

Id invoice

POST
/orders/{id}/messages

Id messages

POST
/orders/{id}/optimise

Id optimise

POST
/orders/{id}/rebook

Id rebook

GET
/orders/{id}/reviews

Id reviews

POST
/orders/{id}/reviews

Id reviews

PATCH
/orders/{id}/schedule

Id schedule

GET
/orders/{id}/stream

Id stream

GET
/orders/{id}/thread

Id thread

POST
/orders/{id}/tip

Id tip

GET
/orders/{orderId}/claims

OrderId claims

POST
/orders/{orderId}/claims

OrderId claims

GET
/orders/{orderId}/returns

OrderId returns

POST
/orders/{orderId}/returns

OrderId returns

payments4 routes
GET
/payments

Payments

POST
/payments/{id}/confirm

Id confirm

POST
/payments/{id}/refund

Id refund

POST
/payments/intent

Intent

promos1 routes
POST
/promos/validate

Validate

public5 routes
GET
/public/cms/{slug}

Cms slug

GET
/public/coverage

Coverage

GET
/public/faqs

Faqs

GET
/public/stats

Stats

GET
/public/v1/track/{code}

V1 track code

quotes2 routes
POST
/quotes

Quotes

GET
/quotes/{id}

Id

support6 routes
POST
/support/assistant

Assistant

GET
/support/tickets

Tickets

POST
/support/tickets

Tickets

GET
/support/tickets/{id}

Tickets id

PATCH
/support/tickets/{id}

Tickets id

POST
/support/tickets/{id}/messages

Tickets id messages

track1 routes
GET
/track/{code}

Code

wallet3 routes
GET
/wallet

Wallet

POST
/wallet/topups

Topups

POST
/wallet/topups/{id}/confirm

Topups id confirm

webhooks1 routes
POST
/webhooks/payments/{provider}

Payments provider