List bookings
list_bookingsRetrieve and filter campsite bookings by arrival/departure dates, status, guest name, campsite, or external reference. Include contact details for guest emails and phones.
Instructions
Bookings (Pitchup bookings and your Reserved external bookings) with dates, status, lead guest name, party size, pitch, unit, extras, special requests and amounts. Every documented filter is available: creation and modification dates, arrival and departure dates (equals, gt, gte, lt, lte), status, first/last name, campsite, pitch, external_id. Guest emails, phones and addresses only with include_contact_details (in free text, emails, phone numbers, UK postcodes and UK registrations are redacted by default; names and street addresses are not); card details never.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | Created after (documented `after`, which filters on the creation date of the booking; whether the given time itself is included is not documented) | |
| pitch | No | Pitch ID | |
| arrive | No | Arrival date equals | |
| before | No | Created before (documented `before`; whether the given time itself is included is not documented) | |
| depart | No | Departure date equals | |
| status | No | Booking status; sent as its documented numeric key (confirmed = 3, reserved = 7, ...) | |
| campsite | No | Campsite slug | |
| last_name | No | Last name contains | |
| arrive__gt | No | Arrival date after | |
| arrive__lt | No | Arrival date before | |
| depart__gt | No | Departure date after | |
| depart__lt | No | Departure date before | |
| first_name | No | First name contains | |
| arrive__gte | No | Arrival date on or after | |
| arrive__lte | No | Arrival date on or before | |
| depart__gte | No | Departure date on or after | |
| depart__lte | No | Departure date on or before | |
| external_id | No | Your own reference for the booking | |
| max_results | No | ||
| modified_after | No | Modified after: new bookings, amendments and cancellations (documented `modified_after`) | |
| modified_before | No | Modified before (documented `modified_before`) | |
| include_contact_details | No | Include the structured guest email, telephone, postal address, other party members' names, vehicle registration and children's ages, and stop redacting emails, phone numbers, UK postcodes and UK registrations in free text. Without it, special requests are still returned: campsites can ask guests to write the vehicle registration and party names there, and names and street addresses in free text are not redacted |