Public API
  1. Bookings
Public API
  • Welcome to the deskbird Public API
  • Users
    • Lists company users
      GET
    • Lists single company user
      GET
  • Bookings
    • Lists company bookings
      GET
    • Creates booking
      POST
    • Lists single company booking
      GET
    • Updates booking
      PATCH
    • Cancels booking
      PATCH
    • Check in to the booking
      PATCH
    • Early release the booking
      PATCH
  • Groups
    • Lists company user groups
      GET
    • Lists single company user group
      GET
  • Resources
    • Lists company resources
      GET
  • Offices
    • Lists company offices
      GET
    • Check User into Office
      POST
  1. Bookings

Lists company bookings

GET
/bookings
Returns company bookings within a provided timeframe

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://connect.deskbird.com/bookings' \
--header 'Authorization;'

Responses

🟢200OK
application/json
List of bookings matching the provided filters
Body

Example
{
    "data": [
        {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "anonymized": false,
            "autoCancellationTime": "2021-01-01T00:00:00.000Z",
            "checkInStatus": "checkedIn",
            "earlyReleaseEndTime": "2021-01-01T00:00:00.000Z",
            "endTime": "2021-01-01T00:00:00.000Z",
            "guest": {
                "firstName": "John",
                "lastName": "Doe",
                "email": "john.doe@example.com"
            },
            "isAnonymousBooking": false,
            "startTime": "2021-01-01T00:00:00.000Z",
            "status": "accepted",
            "zoneId": "1234",
            "floorId": "1122",
            "resourceId": "123e4567-e89b-12d3-a456-426614174000",
            "resource": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "Desk 1",
                "type": "flexDesk"
            },
            "officeId": "3241",
            "user": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "email": "john.doe@example.com",
                "firstName": "John",
                "lastName": "Doe"
            },
            "createdAt": "2021-01-01T00:00:00.000Z",
            "updatedAt": "2021-01-01T00:00:00.000Z"
        }
    ],
    "offset": 0,
    "limit": 10,
    "total": 100
}
🟠401Unauthorized
🟠403Forbidden
Previous
Bookings
Next
Creates booking
Built with