List Bookings

curl --request GET \
  --url https://{base_url}/Bookings \
  --header 'X-API-KEY: <x-api-key>'

{
  "count": 123,
  "bookings": [
    {
      "bookingId": "<string>",
      "locationId": "<string>",
      "method": "<string>",
      "bookedAt": "<string>",
      "bookingTime": "<string>",
      "duration": 123,
      "people": 123,
      "customer": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "phone": "<string>"
      },
      "tables": [
        {
          "tableId": "<string>",
          "tableName": "<string>"
        }
      ],
      "tags": [
        {
          "tagType": "<string>",
          "name": "<string>"
        }
      ]
    }
  ]
}

GET

Bookings

List Bookings

curl --request GET \
  --url https://{base_url}/Bookings \
  --header 'X-API-KEY: <x-api-key>'

{
  "count": 123,
  "bookings": [
    {
      "bookingId": "<string>",
      "locationId": "<string>",
      "method": "<string>",
      "bookedAt": "<string>",
      "bookingTime": "<string>",
      "duration": 123,
      "people": 123,
      "customer": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "phone": "<string>"
      },
      "tables": [
        {
          "tableId": "<string>",
          "tableName": "<string>"
        }
      ],
      "tags": [
        {
          "tagType": "<string>",
          "name": "<string>"
        }
      ]
    }
  ]
}

X-API-KEY

string

required

Your partner API key. Contact partners@nowbookit.com to obtain one.

Query Parameters

ServiceName

string

Filter bookings by service name (e.g., "Dinner", "Lunch").

StartDate

string

Start of the booking date range. Required when EndDate is provided.Format: yyyy-MM-ddTHH:mm:ss.fffZExample: 2024-06-01T00:00:00.000Z

EndDate

string

End of the booking date range. Required when StartDate is provided.Format: yyyy-MM-ddTHH:mm:ss.fffZ

UpdatedFromDate

string

Start of the last-modified date range. Required when UpdatedToDate is provided.Format: yyyy-MM-ddTHH:mm:ss.fffZUse this pair to poll for changes since your last sync.

UpdatedToDate

string

End of the last-modified date range. Required when UpdatedFromDate is provided.Format: yyyy-MM-ddTHH:mm:ss.fffZ

IncludeCustomerDetails

boolean

default:"false"

When true, each booking object will include a nested customer object with the guest’s contact details.

IncludeCancelledBookings

boolean

default:"true"

When false, cancelled bookings are excluded from results.

You must provide either StartDate + EndDate or UpdatedFromDate + UpdatedToDate. Mixing date filter types, or omitting both, will return an empty result set without an error response.

Response

count

integer

Total number of bookings returned in this response.

bookings

array

List of booking objects.

Show Booking Object

bookingId

string

Unique NowBookIt booking identifier.

locationId

string

NowBookIt venue/location identifier.

method

string

How the booking was created (e.g., "online", "phone", "walkin").

bookedAt

string

ISO 8601 timestamp of when the booking was created.

bookingTime

string

ISO 8601 datetime of the booking in venue local time.

duration

integer

Duration of the booking in minutes.

people

integer

Number of guests in the party.

customer

object

Customer details. Only present when IncludeCustomerDetails=true.

Show Customer Object

string

NowBookIt customer ID.

firstName

string

Customer first name.

lastName

string

Customer last name.

string

Customer email address.

phone

string

Customer phone number (international format).

tables

array

List of table assignments for this booking.

Show Table Object

tableId

string

NowBookIt table identifier.

tableName

string

Human-readable table name.

Examples

curl "https://{base_url}/Bookings?StartDate=2024-06-01T00:00:00.000Z&EndDate=2024-06-01T23:59:59.999Z&IncludeCustomerDetails=true" \
  -H "X-API-KEY: your_api_key"

Example Response

{
  "count": 2,
  "bookings": [
    {
      "bookingId": "bk_abc123",
      "locationId": "loc_xyz789",
      "method": "online",
      "bookedAt": "2024-05-28T09:14:22Z",
      "bookingTime": "2024-06-01T19:00:00",
      "duration": 90,
      "people": 4,
      "tables": [
        { "tableId": "tbl_001", "tableName": "Table 5" }
      ],
      "tags": [
        { "tagType": "occasion", "name": "Birthday" }
      ]
    },
    {
      "bookingId": "bk_def456",
      "locationId": "loc_xyz789",
      "method": "phone",
      "bookedAt": "2024-05-30T14:00:00Z",
      "bookingTime": "2024-06-01T20:30:00",
      "duration": 60,
      "people": 2,
      "tables": [],
      "tags": []
    }
  ]
}

Status Codes

Code	Description
`200`	Success
`400`	Missing `loggedInAppId` or no venue linked to your app
`401`	Invalid or missing `X-API-KEY`
`429`	Rate limit exceeded

Authentication & Setup Create Booking

⌘I

​Query Parameters

​Response

​Examples

​Example Response

​Status Codes

Query Parameters

Response

Examples

Example Response

Status Codes