List Bookings

GET/v1/bookings

The List Bookings API retrieves a list of all bookings made by guests. This endpoint returns an array of bookings, each containing essential information such as the booking ID, date, status, and other relevant details. It allows filtering and pagination to manage large datasets.

Request

Query Params

page

number

optional

The number of page.

Example:

perPage

number

optional

The number of items per page.

Example:

status

string

optional

open | cancel

Example:

open

startedAt

string

optional

Include events that started on or after this time (sample time format: "2024-03-01T00:00:00.000Z"). This timezone is UTC.

Example:

2024-06-12T03:00:00.000Z

endedAt

string

optional

Include events that ended on or before this time (sample time format: "2024-04-01T00:00:00.000Z"). This timezone is UTC.

Example:

2024-06-13T03:00:00.000Z

sort

string

optional

asc | desc

Example:

asc

order

string

optional

startedAt | createdAt

Example:

startedAt

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

data

$ref(#/definitions/1332902)[]

required

#/definitions/1332902

optional

errors

object

required

{
  "totalCount": 1626,
  "count": 20,
  "currentPage": 1,
  "nextPage": 2,
  "numberOfPages": 82
}

Last modified: 3 months ago