Onfleet

Manage Onfleet delivery tasks, workers, teams, recipients, hubs, containers, destinations, and organizations.

Overview

Onfleet is a last-mile delivery management platform. This tool allows you to create, read, update, and delete delivery tasks, manage drivers/workers, organize teams, handle recipients, manage hubs (depot locations), work with containers (task assignment groupings), manage destinations, and view organization details. It supports operations like task creation with geocoded destinations, driver time estimates, auto-dispatch of tasks, worker schedule management, and more.

Category: Utility
Tool Name: onfleet
Version: 1

Appearance: Icon: lucide-Truck | Color: #AC45FF

Node Type

Action — processes input items and produces output

Input / Output

Direction	Port(s)
Input	Input
Output	Output, Error

Credentials

This tool requires Onfleet API credentials. See the Credentials Guide for setup instructions.

Resources

Resource	Value
Admin	admin
Container	container
Destination	destination
Hub	hub
Organization	organization
Recipient	recipient
Task	task
Team	team
Worker	worker

Operations

Each resource has its own Operation list, and most resources reuse the same operation values (create, get, getAll, update, delete). Pick the resource first, then the operation.

Resource	Operation	Value
Admin	Create	create
Admin	Delete	delete
Admin	Get Many	getAll
Admin	Update	update
Container	Add Tasks	addTask
Container	Get	get
Container	Update Tasks	updateTask
Destination	Create	create
Destination	Get	get
Hub	Create	create
Hub	Get Many	getAll
Hub	Update	update
Organization	Get My Organization	get
Organization	Get Delegatee Details	getDelegatee
Recipient	Create	create
Recipient	Get	get
Recipient	Update	update
Task	Clone	clone
Task	Complete	complete
Task	Create	create
Task	Delete	delete
Task	Get	get
Task	Get Many	getAll
Task	Update	update
Team	Auto-Dispatch	autoDispatch
Team	Create	create
Team	Delete	delete
Team	Get	get
Team	Get Many	getAll
Team	Get Time Estimates	getTimeEstimates
Team	Update	update
Worker	Create	create
Worker	Delete	delete
Worker	Get	get
Worker	Get Many	getAll
Worker	Get Schedule	getSchedule
Worker	Update	update

Parameters

Organization: Get My Organization takes no parameters of its own.

Every lookup field — Admin ID, Task ID, Destination ID, Hub ID, Organization ID, Recipient ID, Team ID and Worker ID — is the same underlying parameter, id. Only its label changes with the resource you pick, so a JSON configuration always writes "id". All fields accept expressions, so IDs can come from the incoming item ({{ $json.id }}).

Fields typed json expect a JSON object written in Onfleet’s own shape; each one’s description shows the exact wrapper key it needs.

Admin: Create

Parameter	Type	Required	Default	Description
Name	string	Yes	—	The administrator’s name.
Email	string	Yes	—	The administrator’s email address.
Additional Fields	collection	No	{}	Optional administrator properties.
— Phone	string	No	—	The administrator’s phone number.
— Read Only	boolean	No	false	Whether this administrator can perform write operations.

Admin: Update

Parameter	Type	Required	Default	Description
Admin ID (id)	string	Yes	—	The ID of the admin object for lookup.
Update Fields	collection	No	{}	Administrator properties to change. Only the fields you add are sent.
— Name	string	No	—	The administrator’s name.
— Phone	string	No	—	The administrator’s phone number.
— Read Only	boolean	No	false	Whether this administrator can perform write operations.

Admin: Delete

Parameter	Type	Required	Default	Description
Admin ID (id)	string	Yes	—	The ID of the admin object for lookup.

Admin: Get Many

Parameter	Type	Required	Default	Description
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	64	Max number of results to return. (shown when Return All is false)

Container: Get

Parameter	Type	Required	Default	Description
Container Type	options	Yes	workers	The type of container.
				Options: organizations, teams, workers
Container ID	string	Yes	—	The object ID according to the container chosen.

Container: Add Tasks

Parameter	Type	Required	Default	Description
Container Type	options	Yes	workers	The type of container.
				Options: organizations, teams, workers
Container ID	string	Yes	—	The object ID according to the container chosen.
Insert Type (type)	options	Yes	-1	How to insert the tasks.
				Options: -1 (append to the end), 0 (prepend to the front), 1 (insert at a specific index)
Index	number	No	0	The position where the tasks will be inserted. (shown when Insert Type is 1)
Task IDs	string	Yes	—	Comma-separated task IDs to add or set.
Options	collection	No	{}	Optional assignment behavior.
— Consider Dependencies	boolean	No	false	Whether to include the target task’s dependency family in the assignment.

Container: Update Tasks

Parameter	Type	Required	Default	Description
Container ID	string	Yes	—	The object ID according to the container chosen.
Task IDs	string	Yes	—	Comma-separated task IDs to add or set.
Options	collection	No	{}	Optional assignment behavior.
— Consider Dependencies	boolean	No	false	Whether to include the target task’s dependency family in the assignment.

Destination: Create

Parameter	Type	Required	Default	Description
Unparsed Address	boolean	No	false	Whether the address is specified in a single unparsed string.
Destination Address (address)	string	Yes	—	The destination’s street address as a single string. (shown when Unparsed Address is true)
Number (addressNumber)	string	Yes	—	The number component of this address. (shown when Unparsed Address is false)
Street (addressStreet)	string	Yes	—	The name of the street. (shown when Unparsed Address is false)
City (addressCity)	string	Yes	—	The name of the municipality. (shown when Unparsed Address is false)
Country (addressCountry)	string	Yes	—	The name of the country. (shown when Unparsed Address is false)
Additional Fields	collection	No	{}	Optional address detail.
— Address Name	string	No	—	A name associated with this address.
— Apartment	string	No	—	The suite or apartment number.
— Address Notes	string	No	—	Notes about the destination.
— Postal Code	string	No	—	The postal or zip code.
— State	string	No	—	The state or province.

Destination: Get

Parameter	Type	Required	Default	Description
Destination ID (id)	string	Yes	—	The ID of the destination object for lookup.

Hub: Create

Parameter	Type	Required	Default	Description
Name	string	Yes	—	A name to identify the hub.
Destination	json	No	{}	Destination properties as JSON: { “destinationProperties”: { “unparsed”: true, “address”: “123 Main St, City, Country” } }.
Additional Fields	collection	No	{}	Optional hub properties.
— Teams	string	No	—	Comma-separated team IDs to assign this hub to.

Hub: Update

Parameter	Type	Required	Default	Description
Hub ID (id)	string	Yes	—	The ID of the hub object for lookup.
Update Fields	collection	No	{}	Hub properties to change. Only the fields you add are sent.
— Destination	json	No	{}	Updated destination as JSON.
— Name	string	No	—	A new name for the hub.
— Teams	string	No	—	Comma-separated team IDs.

Hub: Get Many

Parameter	Type	Required	Default	Description
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	64	Max number of results to return. (shown when Return All is false)

Organization: Get Delegatee Details

Parameter	Type	Required	Default	Description
Organization ID (id)	string	Yes	—	The ID of the delegatee organization for lookup.

Recipient: Create

Parameter	Type	Required	Default	Description
Recipient Name	string	Yes	—	The recipient’s complete name.
Recipient Phone	string	Yes	—	The recipient’s phone number.
Additional Fields	collection	No	{}	Optional recipient properties.
— Recipient Notes	string	No	—	Global notes for this recipient.
— Skip Recipient SMS Notifications	boolean	No	false	Whether this recipient has requested to skip SMS notifications.
Options	collection	No	{}	Optional creation behavior.
— Skip Recipient Phone Number Validation	boolean	No	false	Whether to skip validation for this recipient’s phone number.

Recipient: Get

Parameter	Type	Required	Default	Description
Get By	options	Yes	id	The method for looking up a recipient.
				Options: id, phone, name
Recipient ID (id)	string	Yes	—	The ID of the recipient. (shown when Get By is id)
Name	string	Yes	—	The name of the recipient for lookup. (shown when Get By is name)
Phone	string	Yes	—	The phone number of the recipient for lookup. (shown when Get By is phone)

Recipient: Update

Parameter	Type	Required	Default	Description
Recipient ID (id)	string	Yes	—	The ID of the recipient object for lookup.
Update Fields	collection	No	{}	Recipient properties to change. Only the fields you add are sent.
— Recipient Name	string	No	—	The recipient’s name.
— Recipient Notes (notes)	string	No	—	Global notes for this recipient.
— Recipient Phone	string	No	—	The recipient’s phone.
— Skip Recipient SMS Notifications (skipSMSNotifications)	boolean	No	false	Whether to skip SMS notifications.

Task: Create

Parameter	Type	Required	Default	Description
Destination	json	Yes	{}	Destination properties as JSON: { “destinationProperties”: { “unparsed”: true, “address”: “123 Main St, City, Country” } }.
Additional Fields	collection	No	{}	Optional task properties.
— Complete After	string	No	—	The earliest time the task should be completed.
— Complete Before	string	No	—	The latest time the task should be completed.
— Executor ID	string	No	—	The ID of the organization responsible for fulfilling the task.
— Merchant ID	string	No	—	The ID of the organization displayed to the recipient.
— Notes	string	No	—	Notes attached to the task.
— Pick Up Task	boolean	No	false	Whether this task is a pickup rather than a drop-off.
— Quantity	number	No	0	Units to be dropped off.
— Recipient	json	No	{}	Recipient properties as JSON: { “recipientProperties”: { “recipientName”: “John”, “recipientPhone”: “+1234567890” } }.
— Recipient Name Override	string	No	—	Override the recipient name for this task only.
— Recipient Notes Override	string	No	—	Override the recipient notes for this task only.
— Recipient Skip SMS Notifications Override	boolean	No	false	Override the recipient’s SMS notification setting for this task only.
— Service Time	number	No	0	Minutes to be spent at the destination.
— Use Merchant For Proxy Override	boolean	No	false	Whether to use the merchant organization for the proxy phone number.

Task: Get

Parameter	Type	Required	Default	Description
Task ID (id)	string	Yes	—	The ID of the task object for lookup. Supports both full ID and short ID (8 characters or less).

Task: Get Many

Parameter	Type	Required	Default	Description
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	64	Max number of results to return. (shown when Return All is false)
Filters	collection	No	{}	Narrow the task list.
— From	string	No	—	The starting time of the range (ISO 8601 or timestamp).
— State	multiOptions	No	—	The state of the tasks.
				Options: all, 0 (unassigned), 1 (assigned), 2 (active), 3 (completed)
— To	string	No	—	The ending time of the range (ISO 8601 or timestamp).

Task: Update

Parameter	Type	Required	Default	Description
Task ID (id)	string	Yes	—	The ID of the task object for lookup. Supports both full ID and short ID (8 characters or less).
Update Fields	collection	No	{}	Task properties to change. Only the fields you add are sent.
— Complete After	string	No	—	The earliest time the task should be completed.
— Complete Before	string	No	—	The latest time the task should be completed.
— Executor ID	string	No	—	The ID of the organization responsible for fulfilling the task.
— Merchant ID	string	No	—	The ID of the organization displayed to the recipient.
— Notes	string	No	—	Notes attached to the task.
— Pick Up Task	boolean	No	false	Whether this task is a pickup rather than a drop-off.
— Quantity	number	No	0	Units to be dropped off.
— Service Time	number	No	0	Minutes to be spent at the destination.

Task: Clone

Parameter	Type	Required	Default	Description
Task ID (id)	string	Yes	—	The ID of the task object for lookup. Supports both full ID and short ID (8 characters or less).
Override Fields	collection	No	{}	Values to change on the clone, and which parts of the original to carry over.
— Complete After	string	No	—	The earliest time the cloned task should be completed.
— Complete Before	string	No	—	The latest time the cloned task should be completed.
— Include Barcodes	boolean	No	false	Whether to copy the original task’s barcodes.
— Include Dependencies	boolean	No	false	Whether to copy the original task’s dependencies.
— Include Metadata	boolean	No	false	Whether to copy the original task’s metadata.
— Notes	string	No	—	Notes for the cloned task.
— Pick Up Task	boolean	No	false	Whether the clone is a pickup rather than a drop-off.
— Service Time	number	No	0	Minutes to be spent at the destination.

Task: Complete

Parameter	Type	Required	Default	Description
Task ID (id)	string	Yes	—	The ID of the task object for lookup. Supports both full ID and short ID (8 characters or less).
Complete as a Success	boolean	Yes	true	Whether the task’s completion was successful.
Additional Fields	collection	No	{}	Optional completion detail.
— Notes	string	No	—	Completion notes.

Task: Delete

Parameter	Type	Required	Default	Description
Task ID (id)	string	Yes	—	The ID of the task object for lookup. Supports both full ID and short ID (8 characters or less).

Team: Create

Parameter	Type	Required	Default	Description
Name	string	Yes	—	A unique name for the team.
Worker IDs	string	Yes	—	Comma-separated worker IDs to assign to this team.
Manager IDs	string	Yes	—	Comma-separated administrator IDs to manage this team.
Additional Fields	collection	No	{}	Optional team properties.
— Hub ID (hub)	string	No	—	The team’s hub ID.
— Self Assignment	boolean	No	false	Whether to allow drivers to self-assign tasks.

Team: Get

Parameter	Type	Required	Default	Description
Team ID (id)	string	Yes	—	The ID of the team object for lookup.

Team: Get Many

Parameter	Type	Required	Default	Description
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	64	Max number of results to return. (shown when Return All is false)

Team: Update

Parameter	Type	Required	Default	Description
Team ID (id)	string	Yes	—	The ID of the team object for lookup.
Update Fields	collection	No	{}	Team properties to change. Only the fields you add are sent.
— Manager IDs	string	No	—	Comma-separated administrator IDs.
— Hub ID (hub)	string	No	—	The team’s hub ID.
— Name	string	No	—	A new name for the team.
— Self Assignment	boolean	No	false	Whether to allow drivers to self-assign tasks.
— Worker IDs	string	No	—	Comma-separated worker IDs.

Team: Delete

Parameter	Type	Required	Default	Description
Team ID (id)	string	Yes	—	The ID of the team object for lookup.

Team: Auto-Dispatch

Parameter	Type	Required	Default	Description
Team ID (id)	string	Yes	—	The ID of the team object for lookup.
Additional Fields	collection	No	{}	Optional dispatch constraints.
— Ending Route	json	No	{}	Route ending config as JSON: { “endingRouteProperties”: { “routeEnd”: “team_hub” } }.
— Max Allowed Delay	number	No	10	Max allowed time in minutes that a task can be late.
— Max Tasks Per Route	number	No	100	Total number of tasks allowed on a route.
— Schedule Time Window	json	No	{}	Schedule time window as JSON: { “scheduleTimeWindowProperties”: { “startTime”: ”…”, “endTime”: ”…” } }.
— Service Time	number	No	2	Default service time in minutes when no task service time exists.
— Task Time Window	json	No	{}	Task time window as JSON: { “taskTimeWindowProperties”: { “startTime”: ”…”, “endTime”: ”…” } }.

Team: Get Time Estimates

Parameter	Type	Required	Default	Description
Team ID (id)	string	Yes	—	The ID of the team object for lookup.
Filters	collection	No	{}	The route the estimate should be calculated for.
— Drop Off	json	No	{}	Drop-off location as JSON: { “dropOffProperties”: { “dropOffLongitude”: -122.4, “dropOffLatitude”: 37.8 } }.
— Pick Up	json	No	{}	Pick-up location as JSON: { “pickUpProperties”: { “pickupLongitude”: -122.4, “pickupLatitude”: 37.8, “pickupTime”: “2024-01-01T12:00:00Z” } }.
— Restricted Vehicle Types	options	No	CAR	Vehicle types to ignore in the query.
				Options: CAR, MOTORCYCLE, BICYCLE, TRUCK
— Service Time	number	No	120	Expected time a worker will take at the location (seconds).

Worker: Create

Parameter	Type	Required	Default	Description
Name	string	Yes	—	The worker’s name.
Phone	string	Yes	—	The worker’s phone number.
Team IDs (teams)	string	Yes	—	Comma-separated team IDs the worker belongs to.
Additional Fields	collection	No	{}	Optional worker properties.
— Capacity	number	No	0	Maximum units this worker can carry.
— Display Name	string	No	—	Name used in SMS notifications and delivery tracking.
— Vehicle	json	No	{}	Vehicle properties as JSON: { “vehicleProperties”: { “type”: “CAR”, “description”: ”…”, “licensePlate”: ”…”, “color”: ”…” } }.

Worker: Get

Parameter	Type	Required	Default	Description
Worker ID (id)	string	Yes	—	The ID of the worker object for lookup.
Options	collection	No	{}	Response shaping options.
— Analytics	boolean	No	true	Whether to include basic worker duty event and analytics.
— Fields to Return (filter)	multiOptions	No	—	A list of fields to show in the response.
				Options: accountStatus, activeTask, capacity, delayTime, displayName, imageUrl, location, metadata, name, onDuty, organization, phone, tasks, teams, timeCreated, timeLastModified, timeLastSeen, userData, vehicle, id (the worker ID)

Worker: Get Many

Parameter	Type	Required	Default	Description
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	64	Max number of results to return. (shown when Return All is false)
Search by Location	boolean	Yes	false	Whether to search for workers within a target area.
Longitude	number	Yes	0	The longitude component of the coordinate pair. (shown when Search by Location is true)
Latitude	number	Yes	0	The latitude component of the coordinate pair. (shown when Search by Location is true)
Filters	collection	No	{}	Area search options. (shown when Search by Location is true)
— Radius	number	No	1000	Radius in meters (max 10000).
Filters	collection	No	{}	Roster filters. (shown when Search by Location is false)
— States	multiOptions	No	—	List of worker states.
				Options: 0 (off-duty), 1 (idle — on-duty, no active task), 2 (active — on-duty with an active task)
— Teams	string	No	—	Comma-separated team IDs to filter by.
— Phones	string	No	—	Comma-separated phone numbers to filter by.
Options	collection	No	{}	Response shaping options.
— Fields to Return (filter)	multiOptions	No	—	A list of fields to show in the response.
				Options: accountStatus, activeTask, capacity, delayTime, displayName, imageUrl, location, metadata, name, onDuty, organization, phone, tasks, teams, timeCreated, timeLastModified, timeLastSeen, userData, vehicle, id (the worker ID)

Worker: Update

Parameter	Type	Required	Default	Description
Worker ID (id)	string	Yes	—	The ID of the worker object for lookup.
Update Fields	collection	No	{}	Worker properties to change. Only the fields you add are sent.
— Capacity	number	No	0	Maximum units this worker can carry.
— Display Name	string	No	—	Name used in SMS notifications and delivery tracking.
— Name	string	No	—	The worker’s name.
— Teams	string	No	—	Comma-separated team IDs.

Worker: Get Schedule

Parameter	Type	Required	Default	Description
Worker ID (id)	string	Yes	—	The ID of the worker object for lookup.

Worker: Delete

Parameter	Type	Required	Default	Description
Worker ID (id)	string	Yes	—	The ID of the worker object for lookup.

All Operations

Parameter	Type	Required	Default	Description
Max Concurrency	number	No	10	Maximum number of items to process concurrently.

Output Data

The Onfleet response is merged onto the input item’s JSON at the top level — the returned fields sit alongside the fields the item already carried, so downstream nodes address them directly ({{ $json.shortId }}). A response field with the same name as an existing item field overwrites it, and an _error property left over from upstream is dropped. Binary data on the input item is forwarded.

Operations	Output
Admin Delete, Task Delete, Task Complete, Team Delete, Worker Delete	One output item carrying success: true — these calls confirm the change instead of returning a record.
Every Get Many	One output item per record, produced from the first input item only. See the note below.
Everything else	One output item carrying the returned Onfleet object.

A created task looks like this:

{
  "id": "11z1BbsQUZFHD1XAd~emDDeK",
  "shortId": "6c8b1d2c",
  "trackingURL": "https://onf.lt/6c8b1d2ca",
  "organization": "yAM*fDkztrT3gUcz9mNDgNOL",
  "state": 0,
  "completeAfter": null,
  "destination": {
    "id": "8AtVUXPLGY9uxOu4E5vhOR1",
    "address": {
      "number": "123",
      "street": "Main St",
      "city": "San Francisco",
      "country": "United States"
    },
    "location": [-122.4194, 37.7749]
  },
  "recipients": [],
  "timeCreated": 1768478400000
}

Get Many behaves differently from the other operations. The list query runs once and its records are emitted from the first input item; any further input items pass straight through with their own JSON unchanged and no records attached. Feed these operations a single item — for example from a manual trigger — rather than a batch.

Task: Get accepts the eight-character short ID printed on the Onfleet dashboard as well as the full ID, so you can wire it straight to a scanned or pasted reference.

Usage Examples

• Create a delivery task to 123 Main St
• Get all active workers
• List all delivery tasks from the past week
• Auto-dispatch tasks to team drivers
• Get driver time estimates for a team

Example Configuration

Create a delivery task from a single-line address:

{
  "type": "onfleet",
  "parameters": {
    "resource": "task",
    "operation": "create",
    "destination": "{\"destinationProperties\":{\"unparsed\":true,\"address\":\"123 Main St, San Francisco, United States\"}}",
    "additionalFields": {
      "notes": "Leave at the front desk",
      "quantity": 2,
      "serviceTime": 5,
      "recipient": "{\"recipientProperties\":{\"recipientName\":\"John Doe\",\"recipientPhone\":\"+14155551234\"}}"
    }
  }
}

Look up a task by the short ID shown on the dashboard:

{
  "type": "onfleet",
  "parameters": {
    "resource": "task",
    "operation": "get",
    "id": "{{ $json.shortId }}"
  }
}

List the tasks in a time range that are still unassigned or assigned:

{
  "type": "onfleet",
  "parameters": {
    "resource": "task",
    "operation": "getAll",
    "returnAll": false,
    "limit": 64,
    "filters": {
      "from": "2026-01-01T00:00:00Z",
      "to": "2026-01-08T00:00:00Z",
      "state": [0, 1]
    }
  }
}

Mark a task complete with a note:

{
  "type": "onfleet",
  "parameters": {
    "resource": "task",
    "operation": "complete",
    "id": "{{ $json.id }}",
    "success": true,
    "additionalFields": {
      "notes": "Delivered and signed for"
    }
  }
}

Copy a task to a new time window:

{
  "type": "onfleet",
  "parameters": {
    "resource": "task",
    "operation": "clone",
    "id": "{{ $json.id }}",
    "overrideFields": {
      "completeAfter": "2026-02-01T09:00:00Z",
      "completeBefore": "2026-02-01T17:00:00Z",
      "includeMetadata": true,
      "notes": "Redelivery attempt"
    }
  }
}

Create a destination from its individual address components:

{
  "type": "onfleet",
  "parameters": {
    "resource": "destination",
    "operation": "create",
    "unparsed": false,
    "addressNumber": "123",
    "addressStreet": "Main St",
    "addressCity": "San Francisco",
    "addressCountry": "United States",
    "additionalFields": {
      "addressPostalCode": "94105",
      "addressApartment": "4B",
      "addressNotes": "Buzz 4B for entry"
    }
  }
}

Register a recipient:

{
  "type": "onfleet",
  "parameters": {
    "resource": "recipient",
    "operation": "create",
    "recipientName": "{{ $json.customerName }}",
    "recipientPhone": "{{ $json.customerPhone }}",
    "additionalFields": {
      "recipientNotes": "Prefers afternoon deliveries"
    }
  }
}

Find a recipient by phone number:

{
  "type": "onfleet",
  "parameters": {
    "resource": "recipient",
    "operation": "get",
    "getBy": "phone",
    "phone": "+14155551234"
  }
}

Add tasks to the end of a worker’s queue:

{
  "type": "onfleet",
  "parameters": {
    "resource": "container",
    "operation": "addTask",
    "containerType": "workers",
    "containerId": "1LjhGUWdxFbvdsTAAXs0TFos",
    "type": -1,
    "tasks": "11z1BbsQUZFHD1XAd~emDDeK,2Fs3~qy8FYaMlZbtLPGdCq0P",
    "options": {
      "considerDependencies": true
    }
  }
}

List on-duty workers with just the fields you need:

{
  "type": "onfleet",
  "parameters": {
    "resource": "worker",
    "operation": "getAll",
    "byLocation": false,
    "returnAll": true,
    "filters": {
      "states": [1, 2]
    },
    "options": {
      "filter": ["name", "phone", "location", "activeTask"]
    }
  }
}

Find workers within 3 km of a pickup point:

{
  "type": "onfleet",
  "parameters": {
    "resource": "worker",
    "operation": "getAll",
    "byLocation": true,
    "longitude": -122.4194,
    "latitude": 37.7749,
    "filters": {
      "radius": 3000
    }
  }
}

Create a team and give it a hub:

{
  "type": "onfleet",
  "parameters": {
    "resource": "team",
    "operation": "create",
    "name": "Downtown Couriers",
    "workers": "1LjhGUWdxFbvdsTAAXs0TFos",
    "managers": "8AtVUXPLGY9uxOu4E5vhOR1",
    "additionalFields": {
      "hub": "5xrjRQmwWjMcVCK7lZfz1cF6",
      "enableSelfAssignment": true
    }
  }
}

Auto-dispatch a team’s unassigned tasks:

{
  "type": "onfleet",
  "parameters": {
    "resource": "team",
    "operation": "autoDispatch",
    "id": "nz1yLDwPzsA2BOMXAY5A~9E~",
    "additionalFields": {
      "maxAllowedDelay": 15,
      "maxTasksPerRoute": 40,
      "serviceTime": 3,
      "endingRoute": "{\"endingRouteProperties\":{\"routeEnd\":\"team_hub\"}}"
    }
  }
}

Ask a team for a driver time estimate between two points:

{
  "type": "onfleet",
  "parameters": {
    "resource": "team",
    "operation": "getTimeEstimates",
    "id": "nz1yLDwPzsA2BOMXAY5A~9E~",
    "filters": {
      "pickUp": "{\"pickUpProperties\":{\"pickupLongitude\":-122.4,\"pickupLatitude\":37.8,\"pickupTime\":\"2026-02-01T12:00:00Z\"}}",
      "dropOff": "{\"dropOffProperties\":{\"dropOffLongitude\":-122.41,\"dropOffLatitude\":37.77}}",
      "serviceTime": 180
    }
  }
}

Read your own organization record:

{
  "type": "onfleet",
  "parameters": {
    "resource": "organization",
    "operation": "get"
  }
}

Error Handling

Mode	Behavior
stop	Halts workflow on first error
continue	Skips failed items, passes successful ones through
errorPort	Routes failed items to Error output port

Tips

Manage Onfleet delivery tasks, workers, teams, recipients, hubs, containers, destinations, and organizations.