Onfleet · Schema

OnfleetTask

An Onfleet task — the atomic unit of pickup or dropoff work assigned to a worker.

Last Mile DeliveryLogisticsFleet ManagementDispatchRoute OptimizationCouriersDriversTrackingGeocodingWebhookArtificial IntelligenceSoftware-as-a-Service

Properties

Name Type Description
id string 24-character resource identifier.
shortId string
organization string
timeCreated integer Unix milliseconds.
timeLastModified integer
worker stringnull
destination object
recipients array
completeAfter integernull
completeBefore integernull
pickupTask boolean
dependencies array
notes string
quantity integer
serviceTime integer
state integer 0=Unassigned, 1=Assigned, 2=Active, 3=Completed.
trackingURL string
eta integernull
metadata array
View JSON Schema on GitHub

JSON Schema

onfleet-task-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/onfleet/main/json-schema/onfleet-task-schema.json",
  "title": "OnfleetTask",
  "description": "An Onfleet task — the atomic unit of pickup or dropoff work assigned to a worker.",
  "type": "object",
  "properties": {
    "id": {"type": "string", "description": "24-character resource identifier."},
    "shortId": {"type": "string"},
    "organization": {"type": "string"},
    "timeCreated": {"type": "integer", "description": "Unix milliseconds."},
    "timeLastModified": {"type": "integer"},
    "worker": {"type": ["string", "null"]},
    "destination": {"$ref": "onfleet-destination-schema.json"},
    "recipients": {
      "type": "array",
      "items": {"$ref": "onfleet-recipient-schema.json"}
    },
    "completeAfter": {"type": ["integer", "null"]},
    "completeBefore": {"type": ["integer", "null"]},
    "pickupTask": {"type": "boolean"},
    "dependencies": {"type": "array", "items": {"type": "string"}},
    "notes": {"type": "string", "maxLength": 10000},
    "quantity": {"type": "integer"},
    "serviceTime": {"type": "integer"},
    "state": {"type": "integer", "enum": [0, 1, 2, 3], "description": "0=Unassigned, 1=Assigned, 2=Active, 3=Completed."},
    "trackingURL": {"type": "string", "format": "uri"},
    "eta": {"type": ["integer", "null"]},
    "metadata": {"type": "array"}
  },
  "required": ["destination"]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/onfleet-task"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.