Skip to main content
GET
Retrieve bookings

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Scopes

resources.readonly

Read resources and bookings

resources

Read and write resources and bookings

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

createDate[gt]
string

Matches bookings with createDate strictly after this date (ISO 8601).

createDate[gte]
string

Matches bookings with createDate on or after this date (ISO 8601).

createDate[lt]
string

Matches bookings with createDate strictly before this date (ISO 8601).

createDate[lte]
string

Matches bookings with createDate on or before this date (ISO 8601).

endDate[gt]
string

Matches bookings with endDate strictly after this date (ISO 8601).

endDate[gte]
string

Matches bookings with endDate on or after this date (ISO 8601).

endDate[lt]
string

Matches bookings with endDate strictly before this date (ISO 8601).

endDate[lte]
string

Matches bookings with endDate on or before this date (ISO 8601).

startDate[gt]
string

Matches bookings with startDate strictly after this date (ISO 8601).

startDate[gte]
string

Matches bookings with startDate on or after this date (ISO 8601).

startDate[lt]
string

Matches bookings with startDate strictly before this date (ISO 8601).

startDate[lte]
string

Matches bookings with startDate on or before this date (ISO 8601).

companyRefOwner
string<uuid>

UUID of the company whose own bookings to list: bookings the company or its members made, not ones they were added to as attendees. Cannot be combined with customerRef, userRef, or userRefOwner.

customerRef
string<uuid>

UUID of the customer whose bookings to list, both made and attended.

endDate
string
deprecated

Deprecated. Use bracket-notation fields endDate[gt], endDate[gte], endDate[lt], endDate[lte] instead.

includeDeleted
string
deprecated

Deprecated. Use status "canceled" instead. Set to "true" to include deleted bookings.

limit
integer

Maximum number of bookings per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

Required range: 1 <= x <= 100
locationRef
string<uuid>

UUID of the location whose bookings to list. Omit to list bookings across every location of the network.

membershipRefOwner
string<uuid>
deprecated

Deprecated. Use customerRef instead. UUID of the customer whose bookings to list.

nextPageToken
string

Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.

order
string

Sort order as <field>:<direction>, where field is startDate, endDate, createDate or deleteDate and direction is asc or desc. deleteDate lists only cancelled bookings, by when they were cancelled, and cannot be combined with singleBookings. Defaults to startDate:asc when a startDate filter is given, endDate:asc when only an endDate filter is given, and createDate:desc otherwise.

resourceRef
string<uuid>

UUID of the resource whose bookings to list.

singleBookings
string

Set to "true" to expand repeating bookings into single occurrences.

startDate
string
deprecated

Deprecated. Use bracket-notation fields startDate[gt], startDate[gte], startDate[lt], startDate[lte] instead.

status
string

Booking statuses to filter by, e.g. confirmed,canceled. requested lists the booking requests waiting for an administrator, and declined the ones an administrator declined or nobody answered before they started. Defaults to tentative and confirmed, or to canceled when ordering by deleteDate. Comma-separated, one or more of: tentative, confirmed, canceled, requested, declined.

type
string

Resource types of the booked resources to filter by, e.g. room,hotDesk. Defaults to all bookable types. Comma-separated, one or more of: hotDesk, dedicatedDesk, office, parkingLot, room, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio, equipment, station.

userRef
string<uuid>

UUID of the user whose bookings to list, both made and attended. Without locationRef or resourceRef, lists the user's bookings across every location of the network. Cannot be combined with customerRef, companyRefOwner, or userRefOwner.

userRefOwner
string<uuid>

UUID of the user whose own bookings to list: bookings the user made, not ones they were added to as an attendee. Without locationRef or resourceRef, lists the user's own bookings across every location of the network. Cannot be combined with customerRef, companyRefOwner, or userRef.

types
string
deprecated

Deprecated. Use type instead.

Response

OK

bookings
object[]
required

List of bookings.

nextPageToken
string

Pagination token to fetch the next page of results.

searchQueryNext
string

Search query parameters for the next page of results. Includes all filters used to fetch the current page.