Bookings

The Booking API allows you to retrieve booking data from the Deskbird system. You can fetch multiple bookings with various filtering options or retrieve details of a specific booking.

Authentication

All booking-related endpoints require authentication via a valid API Key in the Authorization header. Ensure that you include a valid API key in your requests.

Endpoints

1. Get Bookings

Endpoint:
GET /bookings

Description:
Retrieves a list of bookings based on the provided filters. This endpoint supports pagination and allows filtering by different booking attributes.

Query Parameters:

bookingId (string, optional) – The unique ID of a booking.

endDate (Date, required) – The end date of the search period.

limit (integer, optional) – The maximum number of bookings returned per request.

officeId (string, optional) – The ID of the office where the booking is located.

offset (integer, optional) – The starting point for retrieving bookings (used for pagination).

resourceId (string, optional) – The ID of the resource associated with the booking.

startDate (Date, required) – The start date of the search period.

status (BookingStatus, optional) – The status of the booking.

userId (string, optional) – The ID of the user associated with the booking.

zoneId (string, optional) – The ID of the zone where the booking is located.

Headers:
Authorization: Bearer <your_api_key>

Example Request:

2. Get Single Booking

Endpoint:
GET /bookings/{bookingId}

Description:
Retrieves details of a specific booking by its unique bookingId.

URL Parameters:

bookingId (string, required) – The unique identifier of the booking to be fetched.

Headers:
Authorization: Bearer <your_api_key>

Example Request:

By using the Booking API, you can efficiently manage bookings while ensuring secure access through token-based authentication.

Authentication#

Endpoints#

1. Get Bookings#

2. Get Single Booking#

Authentication

Endpoints

1. Get Bookings

2. Get Single Booking