Skip to navigation
API ReferencePartner API Vehicles and Rentals

Find rentals

View as Markdown

Rentals, with no renter details. Two ways to ask:

  • One lookup: plate and at return the rental that had that plate at that moment, or an empty list. Optional: if you skip it, Fleetwire matches charges by plate and time itself.
  • A period: from and to (at most 93 days apart) return every rental whose trip overlaps the window, paginated, cancelled ones included. Use it for per-rental fees such as a registration fee.

Send one pair or the other, not both. Unconfirmed booking requests are never listed.

Authentication

AuthorizationBearer

Your partner key, starting with fwp_, sent as Authorization: Bearer fwp_…. Keep it server-side. Fleetwire can rotate it at any time; the old key stops working as soon as a new one is issued.

Path parameters

company_idstringRequiredformat: "uuid"

The Fleetwire company ID from GET /companies.

Query parameters

platestringOptional<=20 characters

With at: the plate to look up.

atdatetimeOptional

With plate: the moment to look up.

fromdatetimeOptional

With to: start of the period.

todatetimeOptional

With from: end of the period, at most 93 days after from.

pageintegerOptional>=1Defaults to 1
Period only.
per_pageintegerOptional1-500Defaults to 100
Period only.

Response

The matching rentals. meta is present for a period.

datalist of objects
metaobjectOptional

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error