| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://onfleet.com/api/v2 | link | — | — | — |
Actions (55)
Tasks · 11
- Cancel taskPOST /tasks/{task_id}/cancel
Cancel a task (if supported by state/config).
documented - Clone taskPOST /tasks/{task_id}/clone
Create a copy of an existing task.
documented - Complete taskPOST /tasks/{task_id}/complete
Mark a task as completed (may require POD data).
documented - Create taskPOST /tasks
Create a new task (pickup or dropoff) with optional recipients/destination.
documented - Create tasks in batchPOST /tasks/batch
Create multiple tasks in a single request.
documented - Create tasks in batch - asyncPOST /tasks/batch-async
Submit a batch of tasks for asynchronous processing.
documented - Delete taskDELETE /tasks/{task_id}
Delete a task.
documented - Get single taskGET /tasks/{task_id}
Retrieve a task by its ID.
documented - Get single task by shortIdGET /tasks/{shortId}
Retrieve a task by its shortId.
documented - List tasksGET /tasks/all
Return a paginated list of tasks (supports filtering by time/state).
documented - Update taskPUT /tasks/{task_id}
Update a task (notes, recipient, destination, etc.).
documented
Orders · 9
- Cancel OrderPOST /taskOrders/cancel
Cancel an order.
documented - Clone OrderPOST /taskOrders/{orderId}/clone
Clone an existing Order.
documented - Create OrderPOST /taskOrders
Create an order which correlates to a pair of tasks (pickup and dropoff).
documented - Create Order (Client Portal)POST /taskOrders
Create an Order via the Client Portal flow.
documented - Get OrderGET /taskOrders/{order_shortid}
Retrieve an Order by its shortId.
documented - Get Order (Client Portal)GET /taskOrders/{order_shortid}
Retrieve an Order via the Client Portal flow.
documented - Quote OrderGET /deliveryServices/quote
Request a delivery quote for an Order.
documented - Reject OrderPOST /taskOrders/{orderId}/reject
Courier can reject an Order.
documented - Update OrderPUT /taskOrders/{orderId}
Update an existing Order.
documented
Workers · 6
- Create workerPOST /workers
Create a new driver/worker in your organization.
documented - Delete workerDELETE /workers/{worker_id}
Remove a worker from your organization.
documented - Get single workerGET /workers/{worker_id}
Retrieve details for a specific worker by ID.
documented - Get workers by locationGET /workers/location
Find workers currently within a geographic radius.
documented - List workersGET /workers
Return all workers in your organization.
documented - Update workerPUT /workers/{worker_id}
Update a worker's details.
documented
Teams · 5
- Create teamPOST /teams
Create a new team and assign workers/managers.
documented - Delete teamDELETE /teams/{team_id}
Delete a team.
documented - Get single teamGET /teams/{team_id}
Retrieve a single team's details.
documented - List teamsGET /teams
Return all teams in the organization.
documented - Update teamPUT /teams/{team_id}
Update a team's details.
documented
Administrators · 4
- Create administratorPOST /admins
Create a new administrator for your organization.
documented - Delete administratorDELETE /admins/{admin_id}
Delete an administrator (subject to role constraints).
documented - List administratorsGET /admins
Return all administrators in your organization.
documented - Update administratorPUT /admins/{admin_id}
Update an administrator's details.
documented
Route Optimization · 4
- Abort optimizationPOST /optimizations/{optimizationId}/abort
Abort an ongoing optimization.
documented - Apply optimization resultsPOST /optimizations/{optimizationId}/apply
Apply the optimization results and assign tasks to workers.
documented - Get optimization statusGET /optimizations/{optimizationId}
Check the status of a routing optimization.
documented - Initialize Standard Route OptimizationGET /optimizations
Start a standard RO process to optimize routes.
documented
Route Plans · 4
- Add Tasks to Route PlanPOST /routePlans/{routePlanId}/tasks
Add tasks to an existing Route Plan.
documented - Delete Route PlanDELETE /routePlans/{routePlanId}
Delete a Route Plan.
documented - Get Route PlanGET /routePlans/{routePlanId}
Retrieve a Route Plan by ID.
documented - List Route PlansGET /routePlans
List Route Plans for the organization.
documented
Webhooks · 4
- Create webhookPOST /webhooks
Register a new webhook for events.
documented - Delete webhookDELETE /webhooks/{webhook_id}
Remove a webhook.
documented - List webhooksGET /webhooks
List all webhooks for the organization.
documented - Update webhookPUT /webhooks/{webhook_id}
Update a webhook's configuration.
documented
Hubs · 3
Organizations · 3
- Get delegatee detailsGET /organizations/{organization_id}
Retrieve details for a connected/delegatee organization by ID.
documented - Get organization detailsGET /organization
Retrieve details about your organization.
documented - Get organization detailsGET /organization
Retrieve details about your own organization.
documented