Skip to main content
POST
Check resource availability

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

Path Parameters

resourceId
string<uuid>
required

The id of the resource.

Body

application/json
endDate
string<date-time>
required

The end of the slot to check, in ISO 8601.

startDate
string<date-time>
required

The start of the slot to check, in ISO 8601.

entire
boolean

Set to true to check the entire resource instead of individual seats. Supported for office resources.

quantity
integer

The number of seats to check. Required for seat-based resources such as hot desks, unless entire is true.

Required range: 1 <= x <= 9007199254740991
recurrence
string[]

RRULE lines describing a repeating slot, e.g. RRULE:FREQ=WEEKLY;COUNT=10. The DTSTART line is derived from startDate. The slot is unavailable as soon as any occurrence is.

Response

OK

available
boolean
required

Whether the resource can be booked for the requested slot.

reason
object

The first rule the slot breaks. Present only when available is false.