How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Onfleet Recipients API

Create and look up end customers (recipients) by ID, name, or E.164 phone number. Recipients carrySMS notification preferences and metadata, and can be reused across tasks.

Onfleet Recipients API is one of 9 APIs that Onfleet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Last Mile Delivery, Recipients, and Customers. The published artifact set on APIs.io includes an OpenAPI specification and 1 JSON Schema.

This API exposes 5 operations across 4 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 2.7.

Requests are made against a single base URL, https://onfleet.com/api/v2.

5 operations 4 paths 2 schemas 3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.7
Base URL
https://onfleet.com/api/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Onfleet Recipients API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Recipients 5
POST
/recipients
Create Recipient
createRecipient body → 200
GET
/recipients/{recipientId}
Get Recipient By ID
getRecipient 1 param → 200
PUT
/recipients/{recipientId}
Update Recipient
updateRecipient 1 param body → 200
GET
/recipients/name/{name}
Get Recipient By Name
getRecipientByName 1 param → 200
GET
/recipients/phone/{phone}
Get Recipient By Phone
getRecipientByPhone 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Recipient (9 properties), RecipientCreate (6 properties). Each schema is shown below with its type and property counts.

Recipient
object
9 properties
RecipientCreate
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onfleet-recipients-api-openapi.yml Raw ↑

Other APIs Onfleet publishes across the network.

Onfleet Tasks API
Onfleet Workers API
Onfleet Route Plans API
Onfleet Orders API
Onfleet Organizations & Teams API
Onfleet Destinations API
Onfleet Webhooks API
Onfleet Route Optimization API
Where this information came from

This is an independent, third-party profile of Onfleet Recipients API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.