Book a demo

Get Task

onfleet.get_task
ActionBusiness appsconnection required

Calls the Onfleet API with the connection's credentials.

Read one task, with its destination, recipient and completion detail.

Ask about OnfleetAll Onfleet nodesProvider API docs ↗

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Onfleet
Secret shape
the API key, or {"api_key": "…"}
Config it needs
base_url
Resolved by
config.connection_id, else node.connection_id

Configuration

1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
task_id
The Onfleet id of the task to read.
stringYes——qNMz6CKwQ*26FOslywsiQxhY

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "task_id": "qNMz6CKwQ*26FOslywsiQxhY"
}

Output

One shape.

result

FieldTypeExample
id
The task's Onfleet id.
string—
shortId
The short id that appears in the Onfleet dashboard.
string—
trackingURL
The public tracking link for this task's recipient.
string—
state
The task's state: 0 unassigned, 1 assigned, 2 active, 3 completed.
number—
worker
The id of the worker the task is assigned to, if any.
string—
organization
The id of the organisation the task belongs to.
string—
timeCreated
When the task was created, in Unix milliseconds.
number—
timeLastModified
When the task last changed, in Unix milliseconds.
number—
completeAfter
The earliest completion time asked for, in Unix ms.
number—
completeBefore
The latest completion time asked for, in Unix ms.
number—
pickupTask
Whether this task is a pickup rather than a dropoff.
boolean—
notes
The notes carried on the task.
string—
container.type
What the task is queued on: ORGANIZATION, TEAM or WORKER.
string—
destination.id
The id of the destination the task delivers to.
string—
destination.address.street
The destination's street name.
string—
destination.address.city
The destination's city.
string—
destination.location
The destination's [longitude, latitude] pair.
array—
recipients[].id
The id of a recipient attached to the task.
string—
recipients[].name
That recipient's name.
string—
recipients[].phone
That recipient's phone number.
string—
{
  "completeAfter": 0,
  "completeBefore": 0,
  "container": {
    "type": ""
  },
  "destination": {
    "address": {
      "city": "",
      "street": ""
    },
    "id": "",
    "location": []
  },
  "id": "",
  "notes": "",
  "organization": "",
  "pickupTask": false,
  "recipients": [
    {
      "id": "",
      "name": "",
      "phone": ""
    }
  ],
  "shortId": "",
  "state": 0,
  "timeCreated": 0,
  "timeLastModified": 0,
  "trackingURL": "",
  "worker": ""
}

Related Onfleet nodes

See Get Task run in a workflow.

In a technical demo we add the Onfleet connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demoTalk to sales