Rivier/ Reference/ bookings

Bookings booking list

get/bookings

Bookings, filtered by state, service, time, location, resource (a person, room or thing) or customer.

Before you call

Credential
Authorization: Bearer $KEY
Scope
bookings:read
Mcp
rivier_booking_bookings_list
Graphql
Query.bookings
Sdk
bookings.booking.list
Cli
bookings booking list

Parameters

  • stateobject
    In the query
  • serviceIdstring (uuid)
    In the query
  • locationIdstring (uuid)
    In the query
  • resourceIdstring (uuid)
    In the query
  • contactIdstring (uuid)
    In the query
  • fromstring (date-time)
    In the query
  • tostring (date-time)
    In the query
  • searchstring
    In the query
  • limitinteger
    In the query
  • offsetinteger
    In the query

Responses

  • 200application/json
    Success
    • itemslist of objectrequired
      • idstringrequired
      • serviceIdstringrequired
      • locationIdstring or nullrequired
      • statestringrequired
      • startstringrequired
      • endstringrequired
      • zonestringrequired
      • partySizenumberrequired
      • contactIdstring or nullrequired
      • channelstringrequired
      • priceMinornumberrequired
      • currencystringrequired
      • depositMinornumberrequired
      • paidMinornumberrequired
      • resourceIdslist of stringrequired
      • versionnumberrequired
      • createdAtstringrequired
      • updatedAtstringrequired
      • cancelledAtstring or nullrequired
    • totalnumberrequired
  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown