Lists company 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

offset

number

optional

The offset to start from

Default:

Example:

limit

number

optional

The limit of items to return

Default:

100

Example:

100

startDate

string <date-time>

optional

The start date of the search period

Example:

2024-01-01T23:00:00.000Z

endDate

string <date-time>

optional

The end date of the search period

Example:

2025-02-01T05:15:00.000Z

ids

string

optional

Comma separated list of booking uuids

Example:

fc0f4648-1c38-4e95-bba6-b397c2a458ee,fc0f4648-1c38-4e95-bba6-b397c2a458ee

statuses

enum<string>

optional

Comma separated list of booking statuses

Allowed values:

acceptedcancelledrunningcompletededitedByUser

userIds

string

optional

Comma separated list of user uuids

Example:

07511f82-c781-439f-9f40-f0a4e7bbe23e,07511f82-c781-439f-9f40-f0a4e7bbe23e

zoneIds

string

optional

Comma separated list of zone uuids

Example:

12,14

resourceIds

string

optional

Comma separated list of resource uuids

Example:

12,14

officeIds

string

optional

Comma separated list of office ids

Example:

12,14

Header Params

Authorization

string

required

Public API key for the company

Responses

🟢200OK

application/json

List of bookings matching the provided filters

Body

data

array[object (BookingResponse) {20}]

required

List of bookings

string

required

The ID of the booking

Example:

123e4567-e89b-12d3-a456-426614174000

companyId

string

required

The ID of the company

Example:

123e4567-e89b-12d3-a456-426614174000

userId

string | null

required

The ID of the user who owns the booking. Due to the anonymization, this field can be null.

Example:

123e4567-e89b-12d3-a456-426614174000

anonymized

boolean

required

If the booking was anonymized, this field will be true.

Example:

false

autoCancellationTime

string <date-time> | null

required

The time when the booking will be automatically cancelled if by then it is was not checked in.

Example:

2021-01-01T00:00:00.000Z

checkInStatus

enum<string>

required

Status of the booking check-in.

Allowed values:

checkedIncheckInNotAvailablenotCheckedInreadyForCheckInreadyForNonQRCheckIn

Example:

checkedIn

earlyReleaseEndTime

string <date-time> | null

required

Time when the booking was early released.

Example:

2021-01-01T00:00:00.000Z

endTime

string <date-time>

required

Time until when the booking was made.

Example:

2021-01-01T00:00:00.000Z

guest

required

Guest info if the booking is for guest. null if the guest info was removed from the system. not defined if the booking is not for a guest.

isAnonymousBooking

boolean

required

True if the booking is anonymous.

Example:

false

startTime

string <date-time>

required

Time when the booking starts.

Example:

2021-01-01T00:00:00.000Z

status

enum<string>

required

Status of the booking.

Allowed values:

acceptedcancelledrunningcompletededitedByUser

Example:

accepted

zoneId

string | null

required

The ID of the zone/area where the booked resource is located.

Example:

1234

floorId

string | null

required

The ID of the floor where the booked resource is located.

Example:

1122

resourceId

string

required

The ID of the resource that was booked.

Example:

123e4567-e89b-12d3-a456-426614174000

resource

object

required

Basic information about the booked resource.

Example:

{"id":"123e4567-e89b-12d3-a456-426614174000","name":"Flex Desk 1","type":"flexDesk"}

officeId

string

required

The ID of the office where the booked resource is located.

Example:

3241

user

required

Basic information about the booking user. Due to the anonymization, this field can be null.

createdAt

string <date-time>

required

The time when the booking was created.

Example:

2021-01-01T00:00:00.000Z

updatedAt

string <date-time>

required

The time when the booking was last updated.

Example:

2021-01-01T00:00:00.000Z

offset

number

required

Number of itesm to skip from the filtered results

Example:

limit

number

required

Number of items to return from the filtered results

Example:

total

number

required

Total number of items that match the filter

Example:

100

Example

{
    "data": [
        {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "companyId": "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

Lists company bookings

Request

Request samples

Responses