Search Bookings

• x-api-key

  string

  header

  API key from Settings → Integrations → API.

• Authorization

  string

  header

  The same API key, or an OAuth access token, sent as Authorization: Bearer.

• api_key

  string

  query

  API key query parameter.

• limit

  number

  query
  Default:

  15
• status

  enum<string>

  query
  One of:

  all

  active

  upcoming

  returned

  cancelled
  Default:

  all
• orderBy

  enum<string>

  query
  One of:

  createdAt

  number

  startHireDate

  endHireDate

  priceInCents
  Default:

  number
• query

  string

  query

  Customer name, email, phone, or booking number. Omit if unused. Never pass an empty string.

• dateRange

  object

  query

  Hire overlap window in epoch milliseconds. Omit if unused. Never pass 0. Pass as a JSON string.

  Show fields
• createdAtRange

  object

  query

  Created-at window in epoch milliseconds. Omit if unused. Pass as a JSON string.

  Show fields
• totalRange

  object

  query

  Price filter in whole dollars. Omit if unused. Never pass 0. Pass as a JSON string.

  Show fields
• productID

  string

  query
• stockID

  string

  query
• categoryID

  string

  query
• locationID

  string

  query
• minEndHireDate

  number

  query
• paymentStatuses

  enum<string>[]

  query

  Omit unless filtering to paid or unpaid. An empty array matches nothing — do not pass it as a default. Pass as a JSON string.

  One of:

  paid

  unpaid
• requirePickup

  boolean

  query

JSON result for this operation.