List reservations
Note: Only full reservation partners can read reservations. If you are a lead-gen partner, this endpoint answers with 403 unsupported_organization_type. Read your leads with GET /public/v1/leads instead. See Partner types under Getting started.
Returns the reservations at the locations of the credential's organization. Results are ordered by updated_at, then id, ascending. Pass next_cursor as cursor to read the next page.
The updated_at rule. updated_at changes when the status, the dates, the listing, or the vehicles of a reservation change. A plate change moves updated_at. A change of the renter name or phone does not.
updated_since is inclusive. The response holds reservations whose updated_at equals updated_since.
Overlap. To poll for changes, send updated_since as the last time you read minus 5 minutes. The 5-minute overlap prevents a missed change. Expect to receive some reservations twice, and treat each reservation by id.
In an active item, renter is null when the listing hides renter details.
Request
- Base URL: https://api-staging.neiybor.com
- URL: https://api-staging.neiybor.com/public/v1/reservations
- Auth: HTTP bearer
Query parameters
Return reservations at this location only. Do not send together with external_id.
Return reservations at every location of your organization with this external id. Do not send together with location_id.
ISO 8601 timestamp. Inclusive.
One of pending, active, inactive, or all, or a comma-separated list of pending, active, and inactive. all is not allowed inside a list. Default active.
The next_cursor of the previous page. Opaque.
Page size.
Response
One page of reservations.
Changes
No recorded changes to this operation across all 1 revision of this API.