---
title: "List bookings"
method: GET
path: "/api/v1/bookings"
tags: ["Bookings"]
---

# List bookings

`GET /api/v1/bookings`

## Request

- Base URL: `https://www.gerezi.com`
- URL: `https://www.gerezi.com/api/v1/bookings`
- Auth: HTTP bearer

## Query parameters

- `status` string
- `from` string, date
- `to` string, date
- `guest_name` string
- `contacted` 'true' | 'false'
- `cursor` string
- `per_page` integer

## Response `200`

List of bookings

- object
  - `data` Booking[]
    - `id` string
    - `booking_number` string
    - `guest_id` string, nullable
    - `guest_name` string
    - `guest_email` string, email
    - `guest_phone` string, nullable
    - `guest_count` integer
    - `booking_time` string, date-time
    - `status` 'PENDING' | 'CONFIRMED' | 'CANCELLED' | 'NO_SHOW' | 'COMPLETED' | 'WAITLISTED'
    - `total_amount_cents` integer: Total in cents
    - `notes` string, nullable
    - `contacted_at` string, date-time, nullable: When the guest was last marked as contacted (null = never)
    - `contacted_by` string, nullable: Actor who marked the contact (STAFF:<userId> / API:<keyId>)
    - `contact_channel` 'SMS' | 'WHATSAPP' | 'EMAIL' | 'PHONE' | 'OTHER', nullable: Channel used for the contact
    - `service_period_id` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `billing_address` BillingAddress: Client block of a French facture.
      - `name` string, nullable: Person or company the facture is made out to; null = use the guest's name.
      - `street` string
      - `postal_code` string
      - `city` string
      - `country` string: ISO 3166-1 alpha-2, e.g. FR
      - `vat_number` string, nullable: Intra-community VAT number, normalised (no spaces)
    - `billing_address_source` 'booking' | 'guest', nullable: Where billing_address comes from: given for this booking, or the guest's latest address as a fallback.
  - `meta` Meta
    - `page` integer
    - `per_page` integer
    - `total` integer
    - `has_more` boolean
    - `next_cursor` string, nullable

## Other responses

- `401`: Missing or invalid API key
- `403`: Key lacks required scope

---

[API](https://skmtc.dev/gerezi/apis/gerezi-restaurant-api.md) · [All operations](https://skmtc.dev/gerezi/apis/gerezi-restaurant-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gerezi/apis/gerezi-restaurant-api/revisions/323b530e81cb?raw)