> ## Documentation Index
> Fetch the complete documentation index at: https://www.spacebring.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve resources
> Retrieve resources in the location. Resources represent all kind of bookable items like rooms, hot desks, dedicated desks, parking lots. OAuth
Required scopes: resources.readonly or resources
## OpenAPI
````yaml /assets/openapi.json get /resources/v1
openapi: 3.0.2
info:
title: Spacebring
version: 1.0.0
termsOfService: https://www.spacebring.com/terms
servers:
- url: https://api.spacebring.com
security: []
paths:
/resources/v1:
get:
tags:
- Resources
summary: Retrieve resources
description: >-
Retrieve resources in the location. Resources represent all kind of
bookable items like rooms, hot desks, dedicated desks, parking lots.
OAuth
Required scopes: resources.readonly or
resources
operationId: getResources
parameters:
- name: locationRef
in: query
description: The id of the location.
schema:
type: string
format: uuid
required: true
- name: types
in: query
description: >-
The types of resources to retrieve. Pass them as comma separated
values.
schema:
type: string
enum:
- hotDesk
- dedicatedDesk
- office
- parkingLot
- room
- in: query
name: nextPageToken
schema:
$ref: '#/components/schemas/nextPageToken'
description: Token to retrieve the next page of results.
required: false
- in: query
name: limit
schema:
type: integer
format: int64
minimum: 1
maximum: 100
default: 25
description: The number of items to return.
required: false
- in: header
name: spacebring-network-id
schema:
type: string
format: uuid
required: false
description: >-
The id of the network. Required when using bearer token
authentication
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
nextPageToken:
$ref: '#/components/schemas/nextPageToken'
resources:
type: array
items:
$ref: '#/components/schemas/resource'
searchQueryNext:
$ref: '#/components/schemas/searchQueryNext'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- resources.readonly
- resources
components:
schemas:
nextPageToken:
type: string
description: >-
Opaque cursor token for retrieving the next page of results. Pass this
value as the `nextPageToken` query parameter in your next request.
resource:
type: object
properties:
assignments:
type: array
items:
type: object
properties:
company:
description: Company assigned to the resource.
type: object
properties:
id:
type: string
format: uuid
description: Company id.
title:
description: Company name.
type: string
required:
- id
- title
additionalProperties: false
entire:
type: boolean
description: Whether the assignment grants access to the entire resource.
id:
description: Assignment id.
type: string
format: uuid
membership:
description: Membership linked to the assignment.
type: object
properties:
id:
type: string
format: uuid
description: Membership id.
required:
- id
additionalProperties: false
quantity:
description: Assigned quantity when the resource is partially assigned.
type: number
resourceRef:
type: string
format: uuid
description: UUID of the resource the assignment belongs to.
subscription:
type: object
properties:
endDate:
description: ISO timestamp when the assignment ends.
type: string
id:
type: string
format: uuid
description: Subscription id.
startDate:
type: string
description: ISO timestamp when the assignment starts.
required:
- id
- startDate
additionalProperties: false
description: Subscription backing this assignment.
user:
description: User assigned to the resource.
type: object
properties:
email:
description: User email.
nullable: true
type: string
id:
type: string
format: uuid
description: User id.
name:
description: User first name.
nullable: true
type: string
surname:
description: User last name.
nullable: true
type: string
required:
- id
additionalProperties: false
required:
- entire
- resourceRef
- subscription
additionalProperties: false
description: Active resource assignments.
autoRelease:
description: Auto-release settings for no-show bookings.
type: object
properties:
enabled:
type: boolean
description: Whether auto-release is enabled.
interval:
type: string
enum:
- fiveMinutes
- tenMinutes
- fifteenMinutes
description: Minutes after start or creation before the slot is released.
required:
- enabled
- interval
additionalProperties: false
avigilonAltaGroupRef:
description: Avigilon Alta access group reference.
nullable: true
type: number
bookingPermission:
type: string
enum:
- admins
- exclusiveMembers
- members
- networkMembers
- public
description: Who can create bookings on this resource.
bookingStepMinutes:
description: Booking step size in minutes.
type: number
brivoGroupRef:
description: Brivo access group reference.
nullable: true
type: number
capacity:
description: Maximum capacity per booking.
nullable: true
type: number
checkIn:
description: Check-in settings.
type: object
properties:
interval:
type: string
enum:
- zeroMinutes
- fiveMinutes
- tenMinutes
- fifteenMinutes
description: How early before start the guest must check in.
required:
- interval
additionalProperties: false
children:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: Id of the child resource.
title:
type: string
description: Title of the child resource.
required:
- id
- title
additionalProperties: false
description: >-
Child resources when this is a parent resource. Bookings on a child
resource also block the parent.
confirmationEmail:
type: object
properties:
bookingCreatedByAdmin:
type: boolean
description: Send confirmation when an admin creates a booking.
bookingCreatedByMember:
type: boolean
description: Send confirmation when a member creates a booking.
bookingCreatedByNetworkMember:
type: boolean
description: Send confirmation when a network member creates a booking.
bookingCreatedByPublic:
type: boolean
description: Send confirmation when a public user creates a booking.
template:
type: string
description: Email template id for confirmation emails.
required:
- bookingCreatedByAdmin
- bookingCreatedByMember
- bookingCreatedByNetworkMember
- bookingCreatedByPublic
- template
additionalProperties: false
description: Confirmation email settings.
createDate:
type: string
format: date-time
description: ISO timestamp of when the resource was created.
credits:
type: object
properties:
enabled:
type: boolean
description: Whether customers can pay with location credits.
tiers:
type: array
items:
type: object
properties:
flatAmount:
type: number
description: Fixed fee added for this tier.
from:
type: number
description: Start of this price tier in booking minutes.
unitAmount:
type: number
description: Variable price per unit within this tier.
required:
- flatAmount
- from
- unitAmount
additionalProperties: false
description: Stepped credit pricing tiers.
required:
- enabled
- tiers
additionalProperties: false
description: Credit pricing settings.
dayPassesEnabled:
description: Whether day passes are enabled.
type: boolean
description:
type: string
description: Description of the resource.
duration:
type: object
properties:
max:
type: number
description: Maximum booking duration in minutes.
min:
type: number
description: Minimum booking duration in minutes.
public:
type: object
properties:
enabled:
type: boolean
description: Whether public bookers have separate duration limits.
max:
type: number
description: Maximum booking duration in minutes for public bookers.
min:
type: number
description: Minimum booking duration in minutes for public bookers.
required:
- enabled
- max
- min
additionalProperties: false
description: Duration limits for public bookers.
required:
- max
- min
- public
additionalProperties: false
description: Booking duration bounds.
dynamicPricing:
type: object
properties:
deltaAbove:
type: number
description: Maximum price increase percentage when demand is high.
deltaBelow:
type: number
description: Maximum price decrease percentage when demand is low.
enabled:
type: boolean
description: Whether dynamic pricing is enabled.
required:
- deltaAbove
- deltaBelow
- enabled
additionalProperties: false
description: Dynamic pricing settings.
googleCalendar:
description: Google Calendar integration settings.
type: object
properties:
id:
type: string
description: Google Calendar id.
twoWaySyncEnabled:
type: boolean
description: Whether two-way sync is enabled.
required:
- id
- twoWaySyncEnabled
additionalProperties: false
id:
type: string
format: uuid
description: Unique identifier of the resource.
imageUrl:
description: Public URL of the resource image.
type: string
kisiGroupRef:
description: Kisi access group reference.
nullable: true
type: number
locale:
type: string
description: Auto-detected language of the description.
locationRef:
type: string
format: uuid
description: ID of the location.
media:
type: array
items:
type: object
properties:
key:
description: Storage key of the image.
type: string
url:
description: Public URL of the image.
type: string
required:
- key
additionalProperties: false
description: Images attached to the resource.
money:
type: object
properties:
enabled:
type: boolean
description: Whether customers can pay with money.
tiers:
type: array
items:
type: object
properties:
flatAmount:
type: number
description: Fixed fee added for this tier.
from:
type: number
description: Start of this price tier in booking minutes.
unitAmount:
type: number
description: Variable price per unit within this tier.
required:
- flatAmount
- from
- unitAmount
additionalProperties: false
description: Stepped money pricing tiers.
required:
- enabled
- tiers
additionalProperties: false
description: Money pricing settings.
networkRef:
type: string
format: uuid
description: ID of the network.
parentRef:
description: Parent resource id when this is a child resource.
type: string
format: uuid
plans:
description: Plan tiers configured on the resource.
type: object
properties:
enabled:
type: boolean
description: Whether plan-based access is enabled.
tiers:
type: array
items:
type: object
properties:
addons:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: Addon id.
required:
- id
additionalProperties: false
description: Addons included in the tier.
commitmentCycles:
type: number
description: Number of billing cycles in the tier.
credits:
type: number
description: Credits included in the tier.
dayPasses:
description: Day passes included in the tier.
type: number
description:
description: Description of the tier.
type: string
discounts:
deprecated: true
description: Synthetic discount percentages by product type.
type: object
properties:
creditPackages:
type: number
description: Discount percentage for credit packages.
desks:
type: number
description: Discount percentage for desk bookings.
equipment:
type: number
description: Discount percentage for equipment bookings.
events:
type: number
description: Discount percentage for events.
rooms:
type: number
description: Discount percentage for room bookings.
shop:
type: number
description: Discount percentage for shop products.
additionalProperties: false
entire:
type: boolean
description: Whether the tier grants access to the entire resource.
grantedDiscounts:
type: array
items:
type: object
properties:
coupon:
type: object
properties:
amountOff:
description: Fixed discount amount.
type: number
currencyCode:
description: Currency code for amountOff.
type: string
enabledForCredits:
description: Whether the coupon applies to credit purchases.
type: boolean
id:
type: string
format: uuid
description: Unique identifier of the coupon.
limitedItems:
type: object
properties:
enabled:
type: boolean
description: Whether item-level limits are enabled.
values:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the limited item.
title:
description: Display name of the limited item.
type: string
type:
type: string
enum:
- roomBookings
- eventSpaceBookings
- conferenceRoomBookings
- meetingRoomBookings
- phoneBoothBookings
- stationBookings
- studioBookings
- hotDeskBookings
- dedicatedDeskBookings
- parkingBookings
- equipmentBookings
- eventTickets
- shopProducts
- packages
- subscriptionItems
description: Product type of the limited item.
required:
- id
- type
additionalProperties: false
description: >-
Product or package the coupon is limited
to.
description: >-
Items the coupon applies to when limits are
enabled.
required:
- enabled
- values
additionalProperties: false
description: Item-level redemption limits.
limitedRedemption:
type: object
properties:
enabled:
type: boolean
description: Whether redemption limits are enabled.
usage:
type: number
description: Current redemption count.
value:
type: number
description: Maximum redemption count.
required:
- enabled
- usage
- value
additionalProperties: false
description: Redemption limits for the coupon.
percentOff:
description: Percentage discount.
type: number
productTypes:
type: array
items:
type: string
enum:
- roomBookings
- eventSpaceBookings
- conferenceRoomBookings
- meetingRoomBookings
- phoneBoothBookings
- stationBookings
- studioBookings
- hotDeskBookings
- dedicatedDeskBookings
- parkingBookings
- equipmentBookings
- eventTickets
- shopProducts
- packages
- subscriptionItems
description: Product types the coupon applies to.
required:
- id
additionalProperties: false
description: Granted coupon details.
required:
- coupon
additionalProperties: false
description: Coupons granted to members on this tier.
id:
type: string
format: uuid
description: Unique identifier of the tier.
period:
type: string
enum:
- day
- week
- month
- threeMonths
- sixMonths
- year
description: Billing period of the tier.
plan:
type: object
properties:
commitmentCycles:
type: number
description: Number of billing cycles in the tier.
credits:
type: number
description: Credits included in the tier.
dayPasses:
description: Day passes included in the tier.
type: number
discounts:
deprecated: true
description: Synthetic discount percentages by product type.
type: object
properties:
creditPackages:
type: number
description: Discount percentage for credit packages.
desks:
type: number
description: Discount percentage for desk bookings.
equipment:
type: number
description: Discount percentage for equipment bookings.
events:
type: number
description: Discount percentage for events.
rooms:
type: number
description: Discount percentage for room bookings.
shop:
type: number
description: Discount percentage for shop products.
additionalProperties: false
grantedDiscounts:
type: array
items:
type: object
properties:
coupon:
type: object
properties:
amountOff:
description: Fixed discount amount.
type: number
currencyCode:
description: Currency code for amountOff.
type: string
enabledForCredits:
description: >-
Whether the coupon applies to credit
purchases.
type: boolean
id:
type: string
format: uuid
description: Unique identifier of the coupon.
limitedItems:
type: object
properties:
enabled:
type: boolean
description: Whether item-level limits are enabled.
values:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the limited item.
title:
description: Display name of the limited item.
type: string
type:
type: string
enum:
- roomBookings
- eventSpaceBookings
- conferenceRoomBookings
- meetingRoomBookings
- phoneBoothBookings
- stationBookings
- studioBookings
- hotDeskBookings
- dedicatedDeskBookings
- parkingBookings
- equipmentBookings
- eventTickets
- shopProducts
- packages
- subscriptionItems
description: Product type of the limited item.
required:
- id
- type
additionalProperties: false
description: >-
Product or package the coupon is limited
to.
description: >-
Items the coupon applies to when limits
are enabled.
required:
- enabled
- values
additionalProperties: false
description: Item-level redemption limits.
limitedRedemption:
type: object
properties:
enabled:
type: boolean
description: Whether redemption limits are enabled.
usage:
type: number
description: Current redemption count.
value:
type: number
description: Maximum redemption count.
required:
- enabled
- usage
- value
additionalProperties: false
description: Redemption limits for the coupon.
percentOff:
description: Percentage discount.
type: number
productTypes:
type: array
items:
type: string
enum:
- roomBookings
- eventSpaceBookings
- conferenceRoomBookings
- meetingRoomBookings
- phoneBoothBookings
- stationBookings
- studioBookings
- hotDeskBookings
- dedicatedDeskBookings
- parkingBookings
- equipmentBookings
- eventTickets
- shopProducts
- packages
- subscriptionItems
description: Product types the coupon applies to.
required:
- id
additionalProperties: false
description: Granted coupon details.
required:
- coupon
additionalProperties: false
description: Coupons granted to members on this tier.
id:
type: string
format: uuid
description: Unique identifier of the tier.
period:
type: string
enum:
- day
- week
- month
- threeMonths
- sixMonths
- year
description: Billing period of the tier.
price:
type: number
description: Price of the tier.
title:
type: string
description: Title of the tier.
required:
- commitmentCycles
- credits
- dayPasses
- grantedDiscounts
- id
- period
- price
- title
additionalProperties: false
description: Nested plan details on responses.
price:
type: number
description: Price of the tier.
selfSignupType:
description: Self sign-up flow type for the tier.
type: string
setupFee:
type: number
description: One-time setup fee for the tier.
title:
type: string
description: Title of the tier.
required:
- addons
- commitmentCycles
- credits
- entire
- grantedDiscounts
- id
- period
- plan
- price
- setupFee
- title
additionalProperties: false
description: Plan tiers configured on the resource.
required:
- enabled
- tiers
additionalProperties: false
preparationMinutes:
type: string
enum:
- zeroMinutes
- fiveMinutes
- tenMinutes
- fifteenMinutes
- thirtyMinutes
- sixtyMinutes
description: Preparation time before bookings.
refundThreshold:
type: string
enum:
- noRefund
- zeroMinutes
- fifteenMinutes
- thirtyMinutes
- oneHour
- twoHours
- fourHours
- sixHours
- twelveHours
- oneDay
- twoDays
- oneWeek
- twoWeeks
- fourWeeks
description: Refund threshold for cancellations.
saltoksAccessGroupRef:
description: Salto KS access group reference.
nullable: true
type: string
format: uuid
schedule:
description: Availability schedule.
type: object
properties:
default:
type: object
properties:
closedDays:
type: array
items:
type: string
description: Dates in MM-DD format when the resource is closed.
items:
type: array
items:
type: object
properties:
days:
type: object
properties:
friday:
type: boolean
description: >-
Whether Friday is included in this schedule
window.
monday:
type: boolean
description: >-
Whether Monday is included in this schedule
window.
saturday:
type: boolean
description: >-
Whether Saturday is included in this schedule
window.
sunday:
type: boolean
description: >-
Whether Sunday is included in this schedule
window.
thursday:
type: boolean
description: >-
Whether Thursday is included in this schedule
window.
tuesday:
type: boolean
description: >-
Whether Tuesday is included in this schedule
window.
wednesday:
type: boolean
description: >-
Whether Wednesday is included in this schedule
window.
required:
- friday
- monday
- saturday
- sunday
- thursday
- tuesday
- wednesday
additionalProperties: false
description: Weekdays this time window applies to.
hours:
type: object
properties:
from:
type: string
description: Opening time in 24-hour "HH:mm" format.
to:
type: string
description: Closing time in 24-hour "HH:mm" format.
required:
- from
- to
additionalProperties: false
description: Open hours for the selected weekdays.
required:
- days
- hours
additionalProperties: false
description: Weekly availability windows for members.
required:
- closedDays
- items
additionalProperties: false
description: Default availability schedule.
enabled:
type: boolean
description: Whether scheduling is enabled.
public:
type: object
properties:
closedDays:
type: array
items:
type: string
description: >-
Dates in MM-DD format when the resource is closed for public
bookers.
enabled:
type: boolean
description: Whether the public schedule is enabled.
items:
type: array
items:
type: object
properties:
days:
type: object
properties:
friday:
type: boolean
description: >-
Whether Friday is included in this schedule
window.
monday:
type: boolean
description: >-
Whether Monday is included in this schedule
window.
saturday:
type: boolean
description: >-
Whether Saturday is included in this schedule
window.
sunday:
type: boolean
description: >-
Whether Sunday is included in this schedule
window.
thursday:
type: boolean
description: >-
Whether Thursday is included in this schedule
window.
tuesday:
type: boolean
description: >-
Whether Tuesday is included in this schedule
window.
wednesday:
type: boolean
description: >-
Whether Wednesday is included in this schedule
window.
required:
- friday
- monday
- saturday
- sunday
- thursday
- tuesday
- wednesday
additionalProperties: false
description: Weekdays this time window applies to.
hours:
type: object
properties:
from:
type: string
description: Opening time in 24-hour "HH:mm" format.
to:
type: string
description: Closing time in 24-hour "HH:mm" format.
required:
- from
- to
additionalProperties: false
description: Open hours for the selected weekdays.
required:
- days
- hours
additionalProperties: false
description: Weekly availability windows for public bookers.
required:
- closedDays
- enabled
- items
additionalProperties: false
description: Public availability schedule.
required:
- default
- enabled
- public
additionalProperties: false
tapkeyGroupRef:
description: Tapkey access group reference.
nullable: true
type: string
format: uuid
title:
type: string
description: Display name of the resource.
type:
type: string
enum:
- dedicatedDesk
- equipment
- hotDesk
- office
- parkingLot
- room
- station
- conferenceRoom
- eventSpace
- meetingRoom
- phoneBooth
- studio
description: Type of the resource.
visibility:
type: string
enum:
- admins
- exclusiveMembers
- members
- networkMembers
- public
description: Visibility of the resource.
required:
- assignments
- bookingPermission
- children
- confirmationEmail
- createDate
- credits
- description
- duration
- dynamicPricing
- id
- locale
- locationRef
- media
- money
- networkRef
- preparationMinutes
- refundThreshold
- title
- type
- visibility
additionalProperties: false
searchQueryNext:
type: string
description: >-
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.
responseError:
type: object
properties:
message:
type: string
type:
type: string
securitySchemes:
BasicAuth:
type: http
description: >-
See our [authentication
documentation](https://www.spacebring.com/docs/api-reference/authentication#basic-authentication)
for how to authorize your requests
scheme: basic
OAuth2:
type: oauth2
description: >-
See our [authentication
documentation](https://www.spacebring.com/docs/api-reference/authentication#oauth2)
for how to authorize your requests
flows:
authorizationCode:
authorizationUrl: https://api.spacebring.com/oauth2/authorize
tokenUrl: https://api.spacebring.com/oauth2/token
refreshUrl: https://api.spacebring.com/oauth2/token
scopes:
benefits.readonly: Read benefits and applications
benefits: Read and write benefits and applications
community.readonly: Read community companies and memberships
community: Read and write community companies and memberships
events.readonly: Read events and tickets
events: Read and write events and tickets
feed.readonly: Read feed posts
feed: Read and write feed posts
invoices.readonly: Read contracts, credit notes, discounts and invoices
invoices: Read and write contract, credit notes, discounts and invoices
locations.readonly: Read locations
locations: Read and write locations
plans.readonly: Read plans
plans: Read and write plans
resources.readonly: Read resources and bookings
resources: Read and write resources and bookings
subscriptions.readonly: Read subscriptions
subscriptions: Read and write subscriptions
shop.readonly: Read products and orders
shop: Read and write products and orders
support.readonly: Read support tickets
support: Read and write support tickets
transactions.readonly: Read transactions
transactions: Read and write transactions
visitors.readonly: Read visitors
visitors: Read and write visitors
````