List Bookings - Jicoo Developer Potal

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

Authorization

Add parameter in header

X-Jicoo-Api-Key

Example:

X-Jicoo-Api-Key: ********************

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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

data

array[object (Booking) {21}]

required

uid

string

required

Unique identifier for this booking

eventTypeId

string | null

required

EventTypeId associated with this event

name

string

required

Booking name

description

string | null

required

Booking description

status

enum<string>

required

Booking status

Allowed values:

requestopencancel

startedAt

string <date-time>

required

The time that event was scheduled to start in UTC time (e.g. "2024-03-01T20:00:00.000Z").

endedAt

string <date-time>

required

The time that event was scheduled to end in UTC time (e.g. "2024-03-01T21:00:00.000Z").

locationId

required

Location type. like zoom, google meet, etc.

url

string | null

required

online meeting url

phoneNumber

string | null

required

phone number

address

string | null

required

location address

customLocation

string | null

required

custom location name

access

string | null

required

access information

timeZone

string

required

guest selected Timezone

priority

required

Booking priority

cancelReason

string | null

required

Booking cancel reason

cancelledAt

required

Booking cancelled time

cancelledBy

required

Booking canceller

hosts

array [object {2}]

required

createdAt

string <date-time>

required

The time this booking was created

updatedAt

string <date-time>

required

The time this booking was updated

errors

object

required

totalCount

integer

required

total count

count

integer

required

current count

currentPage

integer

required

current page

integer

optional

numberOfPages

integer

required

number of pages

Example

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