Skip to main content

Get reservations by license plate

GET 

/v2/facilities/:facility_id/reservations/by-license-plate/:license_plate

Returns reservations for a facility whose license plate matches the supplied plate. Matching the license plate is case-insensitive and ignores non-alphanumerics (e.g. abc-123 matches a stored ABC 123).

By default only currently-active, non-cancelled reservations are returned i.e. the reservation must be within its start-time & end-time window at the time of the request and must not be cancelled. Set all=true to return every reservation matching the plate at the facility, regardless of window or cancellation status - this will include reservations matching the license plate in the past, that were cancelled, and any upcoming rentals.

Results are ordered most-recently-created first.

This endpoint may return multiple pages, use the @next cursor in the response to fetch subsequent pages. A non-null @next means there may be more results.

Optional include parameters enable entitlement-restricted projections.

Request​

Responses​

Successful response