Skip to main content
GET
/
resources
/
bookings
/
v1
Retrieve bookings
curl --request GET \
  --url https://api.spacebring.com/resources/bookings/v1 \
  --header 'Authorization: Basic <encoded-value>'
{
  "bookings": [
    {
      "attendees": [
        {
          "membershipRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "user": {
            "about": "<string>",
            "email": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "phoneNumber": "<string>",
            "photoUrl": "<string>",
            "surname": "<string>"
          }
        }
      ],
      "createDate": "2023-11-07T05:31:56Z",
      "deleteDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "memo": "<string>",
      "membershipRefOwner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment": {
        "amount": 123,
        "currencyCode": "<string>",
        "invoiceItemRef": "<string>",
        "tax": {
          "inclusive": true,
          "rate": 123
        },
        "transactionRef": "<string>"
      },
      "resourceRef": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "seats": 123,
      "startDate": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "updateDate": "2023-11-07T05:31:56Z",
      "userOwner": {
        "about": "<string>",
        "email": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "phoneNumber": "<string>",
        "photoUrl": "<string>",
        "surname": "<string>"
      }
    }
  ],
  "nextPageToken": "<string>",
  "searchQueryNext": "<string>"
}

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Headers

spacebring-network-id
string<uuid>

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

Query Parameters

resourceRef
string<uuid>

The id of the resource. Required if locationRef is not passed.

locationRef
string<uuid>

The id of the location. Required if resourceRef is not passed.

membershipRefOwner
string<uuid>

The id of the membership owner.

endDate
object

The date filter of items.

startDate
object

The date filter of items.

limit
integer<int64>
default:25

The number of items to return

Required range: 1 <= x <= 100
order
string
default:endDate:asc

The order of filtered items. Format - field:order. Possible field values are createDate, endDate, startDate, id. Order values - asc, desc.

nextPageToken
string

Token to retrieve the next page of results. Opaque cursor token for retrieving the next page of results. Pass this value as the nextPageToken query parameter in your next request.

types
enum<string>

The types of resources to retrieve bookings for. Pass them as comma separated values.

Available options:
hotDesk,
dedicatedDesk,
office,
parkingLot,
room

Response

OK

bookings
object[]
nextPageToken
string

Opaque cursor token for retrieving the next page of results. Pass this value as the nextPageToken query parameter in your next request.

searchQueryNext
string

Pre-built query string for the next page of results. Contains all active filter parameters combined with the next page token, ready to append to the endpoint URL.