DOCUMENTATION

Endpoint reference

127 concrete operations, generated from the OpenAPI contract and checked against the server routes.

Find an endpoint

127 operations

Service health2

GET/healthLiveness GET/readyDatabase readiness

Authentication9

POST/api/v1/auth/registerRegister pending business owner POST/api/v1/auth/verifyVerify email and activate business POST/api/v1/auth/loginSign in verified administrator POST/api/v1/auth/logoutRevoke current session GET/api/v1/auth/meRead signed-in account and businesses POST/api/v1/auth/password-reset/requestRequest reset email POST/api/v1/auth/password-reset/completeSet password using recovery challenge POST/api/v1/auth/verification/resendResend verification email POST/api/v1/auth/admin-setupActivate administrator invitation with own password

Business API97

GET/api/v1/businessesSearch accessible active/deleted businesses POST/api/v1/businessesCreate another isolated business GET/api/v1/businesses/{id}/settingsRead authorized business settings PUT/api/v1/businesses/{id}/settingsUpdate authorized business settings GET/api/v1/businesses/{id}/ordersList orders GET/api/v1/businesses/{id}/vehiclesList vehicles GET/api/v1/businesses/{id}/driversList drivers GET/api/v1/businesses/{id}/warehousesList warehouses GET/api/v1/businesses/{id}/schemasList schemas GET/api/v1/businesses/{id}/webhooksList webhooks GET/api/v1/businesses/{id}/regionsList regions GET/api/v1/businesses/{id}/scenariosList scenarios GET/api/v1/businesses/{id}/plansList plans GET/api/v1/businesses/{id}/notificationsList notifications GET/api/v1/businesses/{id}/adminsList own-business administrator memberships/invitations POST/api/v1/businesses/{id}/ordersCreate orders POST/api/v1/businesses/{id}/vehiclesCreate vehicles POST/api/v1/businesses/{id}/driversCreate drivers POST/api/v1/businesses/{id}/warehousesCreate warehouses POST/api/v1/businesses/{id}/schemasCreate schemas POST/api/v1/businesses/{id}/webhooksCreate webhooks POST/api/v1/businesses/{id}/regionsCreate regions POST/api/v1/businesses/{id}/scenariosCreate scenarios POST/api/v1/businesses/{id}/plansCreate plans POST/api/v1/businesses/{id}/notificationsCreate notifications POST/api/v1/businesses/{id}/adminsAdd verified account or email administrator invitation GET/api/v1/businesses/{id}/orders/{record_id}Read orders GET/api/v1/businesses/{id}/vehicles/{record_id}Read vehicles GET/api/v1/businesses/{id}/drivers/{record_id}Read drivers GET/api/v1/businesses/{id}/warehouses/{record_id}Read warehouses GET/api/v1/businesses/{id}/schemas/{record_id}Read schemas GET/api/v1/businesses/{id}/webhooks/{record_id}Read webhooks GET/api/v1/businesses/{id}/regions/{record_id}Read regions GET/api/v1/businesses/{id}/scenarios/{record_id}Read scenarios GET/api/v1/businesses/{id}/plans/{record_id}Read plans GET/api/v1/businesses/{id}/notifications/{record_id}Read notifications GET/api/v1/businesses/{id}/admins/{record_id}Read admins PUT/api/v1/businesses/{id}/orders/{record_id}Update orders PUT/api/v1/businesses/{id}/vehicles/{record_id}Update vehicles PUT/api/v1/businesses/{id}/drivers/{record_id}Update drivers PUT/api/v1/businesses/{id}/warehouses/{record_id}Update warehouses PUT/api/v1/businesses/{id}/schemas/{record_id}Update schemas PUT/api/v1/businesses/{id}/webhooks/{record_id}Update webhooks PUT/api/v1/businesses/{id}/regions/{record_id}Update regions PUT/api/v1/businesses/{id}/scenarios/{record_id}Update scenarios PUT/api/v1/businesses/{id}/plans/{record_id}Update plans PUT/api/v1/businesses/{id}/notifications/{record_id}Update notifications PUT/api/v1/businesses/{id}/admins/{record_id}Update admins PATCH/api/v1/businesses/{id}/orders/{record_id}Update orders PATCH/api/v1/businesses/{id}/vehicles/{record_id}Update vehicles PATCH/api/v1/businesses/{id}/drivers/{record_id}Update drivers PATCH/api/v1/businesses/{id}/warehouses/{record_id}Update warehouses PATCH/api/v1/businesses/{id}/schemas/{record_id}Update schemas PATCH/api/v1/businesses/{id}/webhooks/{record_id}Update webhooks PATCH/api/v1/businesses/{id}/regions/{record_id}Update regions PATCH/api/v1/businesses/{id}/scenarios/{record_id}Update scenarios PATCH/api/v1/businesses/{id}/plans/{record_id}Update plans PATCH/api/v1/businesses/{id}/notifications/{record_id}Update notifications PATCH/api/v1/businesses/{id}/admins/{record_id}Update admins DELETE/api/v1/businesses/{id}/orders/{record_id}Soft-delete orders DELETE/api/v1/businesses/{id}/vehicles/{record_id}Soft-delete vehicles DELETE/api/v1/businesses/{id}/drivers/{record_id}Soft-delete drivers DELETE/api/v1/businesses/{id}/warehouses/{record_id}Soft-delete warehouses DELETE/api/v1/businesses/{id}/schemas/{record_id}Soft-delete schemas DELETE/api/v1/businesses/{id}/webhooks/{record_id}Soft-delete webhooks DELETE/api/v1/businesses/{id}/regions/{record_id}Soft-delete regions DELETE/api/v1/businesses/{id}/scenarios/{record_id}Soft-delete scenarios DELETE/api/v1/businesses/{id}/plans/{record_id}Soft-delete plans DELETE/api/v1/businesses/{id}/notifications/{record_id}Soft-delete notifications DELETE/api/v1/businesses/{id}/admins/{admin}Remove membership or pending invitation GET/api/v1/businesses/{id}/eventsRead business operational event journal POST/api/v1/businesses/{id}/working-hours/previewPreview/apply calendar working-hour change POST/api/v1/businesses/{id}/working-hours/applyPreview/apply calendar working-hour change GET/api/v1/businesses/{id}/api-keysList scoped integration keys POST/api/v1/businesses/{id}/api-keysCreate key; secret returned once DELETE/api/v1/businesses/{id}/api-keys/{key}Soft-delete and revoke an integration key POST/api/v1/businesses/{id}/planning/previewStart real background planning job GET/api/v1/businesses/{id}/planning/jobs/{job}Read business planning job POST/api/v1/businesses/{id}/scenarios/{scenario}/runRun actual graph pathfinding/scheduling POST/api/v1/businesses/{id}/plans/publishPublish reviewed planning/status changes POST/api/v1/businesses/{id}/plans/manual-moveManual scheduling adjustment PATCH/api/v1/businesses/{id}/plans/{plan}/stops/{order}Move/reorder/change draft stop POST/api/v1/businesses/{id}/availabilityDiscover/check exact candidate appointment windows POST/api/v1/businesses/{id}/reservations/{offer}/confirmAtomically create and schedule one reservation order POST/api/v1/businesses/{id}/regions/{region}/installApprove/rebuild local map coverage POST/api/v1/businesses/{id}/regions/{region}/updateApprove/rebuild local map coverage GET/api/v1/businesses/{id}/maps/stylesGet business local MapLibre style GET/api/v1/businesses/{id}/maps/tiles/{z}/{x}/{y}Read private local vector tile GET/api/v1/businesses/{id}/maps/jobs/{job}Get approved region build status GET/api/v1/businesses/{id}/orders/{order}/evidenceList private completion evidence POST/api/v1/businesses/{id}/orders/{order}/evidenceUpload administrator-managed evidence GET/api/v1/businesses/{id}/orders/{order}/evidence/{evidence}Download private image DELETE/api/v1/businesses/{id}/orders/{order}/evidence/{evidence}Delete completion evidence POST/api/v1/businesses/{id}/drivers/{driver}/password-resetIssue driver recovery activation code GET/api/v1/businesses/{id}/maps/coverage-proposalSuggest approximate coverage for own-business work/regions DELETE/api/v1/businesses/{id}Soft-delete an authorized business POST/api/v1/businesses/{id}/api-keys/{key}/revokeRevoke an integration key without deleting its retained record

Driver API19

POST/api/v1/driver/loginDriver login POST/api/v1/driver/activateDriver activate POST/api/v1/driver/forgot-passwordDriver forgot-password POST/api/v1/driver/logoutDriver logout GET/api/v1/driver/refreshDriver refresh POST/api/v1/driver/dutyDriver duty POST/api/v1/driver/locationDriver location POST/api/v1/driver/orders/{order}/startDriver order start POST/api/v1/driver/orders/{order}/completeDriver order complete POST/api/v1/driver/orders/{order}/unableDriver order unable POST/api/v1/driver/orders/{order}/custom-fieldsDriver order custom-fields GET/api/v1/driver/orders/{order}/evidenceList active private evidence for own published order POST/api/v1/driver/orders/{order}/evidenceDriver order evidence GET/api/v1/driver/maps/stylesRead own-business local map style as authorized driver GET/api/v1/driver/maps/tiles/{z}/{x}/{y}Read private local vector tile through driver-session context GET/api/v1/driver/push-devicesList own driver push-device registrations POST/api/v1/driver/push-devicesRegister APNs/FCM device for published-plan notifications DELETE/api/v1/driver/push-devices/{device}Revoke own driver push-device registration GET/api/v1/driver/orders/{order}/evidence/{evidence}Download private image for own published order