resources
## OpenAPI
````yaml /assets/openapi.json post /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:
post:
tags:
- Resources
summary: Create a resource
description: >-
Create a new resource in a location. The request body must match the
schema exactly—unknown properties are rejected. resources
operationId: createResource
parameters:
- 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
requestBody:
$ref: '#/components/requestBodies/createResource'
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
resource:
$ref: '#/components/schemas/resource'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- resources
components:
requestBodies:
createResource:
required: true
content:
application/json:
schema:
type: object
properties:
resource:
type: object
properties:
autoRelease:
type: object
properties:
enabled:
type: boolean
interval:
type: string
enum:
- fiveMinutes
- tenMinutes
- fifteenMinutes
avigilonAltaGroupRef:
type: string
bookingPermission:
type: string
enum:
- admins
- exclusiveMembers
- members
- networkMembers
- public
bookingStepMinutes:
type: integer
brivoGroupRef:
type: string
capacity:
type: integer
checkIn:
type: object
properties:
interval:
type: string
enum:
- zeroMinutes
- fiveMinutes
- tenMinutes
- fifteenMinutes
confirmationEmail:
type: object
properties:
bookingCreatedByAdmin:
type: boolean
bookingCreatedByMember:
type: boolean
bookingCreatedByNetworkMember:
type: boolean
bookingCreatedByPublic:
type: boolean
template:
type: string
credits:
type: object
properties:
enabled:
type: boolean
price:
type: number
description: Optional display price; tier data is authoritative.
tiers:
type: array
items:
type: object
properties:
flatAmount:
type: number
from:
type: number
unitAmount:
type: number
upTo:
type: integer
dayPassesEnabled:
type: boolean
description:
type: string
dynamicPricing:
type: object
properties:
deltaAbove:
type: number
deltaBelow:
type: number
enabled:
type: boolean
duration:
type: object
description: Booking duration bounds and public-facing limits.
properties:
max:
type: number
min:
type: number
public:
type: object
properties:
enabled:
type: boolean
max:
type: number
min:
type: number
googleCalendar:
type: object
properties:
id:
type: string
twoWaySyncEnabled:
type: boolean
kisiGroupRef:
type: number
locationRef:
type: string
format: uuid
description: Location id.
money:
type: object
properties:
enabled:
type: boolean
price:
type: number
description: Optional display price; tier data is authoritative.
tiers:
type: array
items:
type: object
properties:
flatAmount:
type: number
from:
type: number
unitAmount:
type: number
upTo:
type: integer
parentRef:
type: string
format: uuid
description: Parent room id when creating a child resource.
plans:
type: object
properties:
enabled:
type: boolean
tiers:
type: array
items:
type: object
description: >-
Create payloads use flat tier fields; responses may
nest details under `plan`.
properties:
entire:
type: boolean
plan:
type: object
properties:
commitmentCycles:
type: number
credits:
type: number
dayPasses:
type: number
discounts:
$ref: >-
#/components/schemas/productTypeDiscountPercentages
grantedDiscounts:
description: Coupons to grant to members on this tier.
type: array
items:
$ref: >-
#/components/schemas/grantedDiscountWritable
id:
type: string
format: uuid
period:
type: string
enum:
- day
- week
- month
- threeMonths
- sixMonths
- year
price:
type: number
title:
type: string
commitmentCycles:
type: number
credits:
type: number
dayPasses:
type: number
description:
type: string
discounts:
$ref: >-
#/components/schemas/productTypeDiscountPercentages
grantedDiscounts:
description: Coupons to grant to members on this tier.
type: array
items:
$ref: '#/components/schemas/grantedDiscountWritable'
ezeepBlueGroupRef:
type: string
id:
type: string
format: uuid
period:
type: string
price:
type: number
selfSignupType:
type: string
setupFee:
type: number
title:
type: string
preparationMinutes:
type: string
enum:
- zeroMinutes
- fiveMinutes
- tenMinutes
- fifteenMinutes
- thirtyMinutes
- sixtyMinutes
refundThreshold:
type: string
enum:
- noRefund
- zeroMinutes
- fifteenMinutes
- thirtyMinutes
- oneHour
- twoHours
- fourHours
- sixHours
- twelveHours
- oneDay
- twoDays
- oneWeek
- twoWeeks
- fourWeeks
saltoksAccessGroupRef:
type: string
format: uuid
schedule:
type: object
description: Default and public availability windows.
properties:
default:
type: object
properties:
closedDays:
type: array
items:
type: string
items:
type: array
items:
type: object
properties:
days:
type: object
properties:
friday:
type: boolean
monday:
type: boolean
saturday:
type: boolean
sunday:
type: boolean
thursday:
type: boolean
tuesday:
type: boolean
wednesday:
type: boolean
hours:
type: object
properties:
from:
type: string
to:
type: string
enabled:
type: boolean
public:
type: object
properties:
closedDays:
type: array
items:
type: string
enabled:
type: boolean
items:
type: array
items:
type: object
properties:
days:
type: object
properties:
friday:
type: boolean
monday:
type: boolean
saturday:
type: boolean
sunday:
type: boolean
thursday:
type: boolean
tuesday:
type: boolean
wednesday:
type: boolean
hours:
type: object
properties:
from:
type: string
to:
type: string
tapkeyGroupRef:
type: string
format: uuid
title:
type: string
minLength: 1
type:
type: string
enum:
- dedicatedDesk
- equipment
- hotDesk
- office
- parkingLot
- room
visibility:
type: string
enum:
- admins
- exclusiveMembers
- members
- networkMembers
- public
required:
- locationRef
- title
- type
required:
- resource
schemas:
resource:
type: object
description: >
Resource representation. Public create uses the same field set with
required top-level fields
documented on the create request body; omit read-only fields
(`createDate`, `imageUrl`, `locale`, `networkRef`) on create.
properties:
autoRelease:
type: object
properties:
enabled:
type: boolean
interval:
type: string
enum:
- fiveMinutes
- tenMinutes
- fifteenMinutes
avigilonAltaGroupRef:
type: string
bookingPermission:
type: string
enum:
- admins
- exclusiveMembers
- members
- networkMembers
- public
bookingStepMinutes:
type: integer
brivoGroupRef:
type: string
capacity:
type: integer
checkIn:
type: object
properties:
interval:
type: string
enum:
- zeroMinutes
- fiveMinutes
- tenMinutes
- fifteenMinutes
confirmationEmail:
type: object
properties:
bookingCreatedByAdmin:
type: boolean
bookingCreatedByMember:
type: boolean
bookingCreatedByNetworkMember:
type: boolean
bookingCreatedByPublic:
type: boolean
template:
type: string
createDate:
readOnly: true
allOf:
- $ref: '#/components/schemas/dateSchema'
credits:
type: object
properties:
enabled:
type: boolean
price:
type: number
description: Optional display price; tier data is authoritative.
tiers:
type: array
items:
type: object
properties:
flatAmount:
type: number
from:
type: number
unitAmount:
type: number
upTo:
type: integer
dayPassesEnabled:
type: boolean
description:
type: string
dynamicPricing:
type: object
properties:
deltaAbove:
type: number
deltaBelow:
type: number
enabled:
type: boolean
duration:
type: object
description: Booking duration bounds and public-facing limits.
properties:
max:
type: number
min:
type: number
public:
type: object
properties:
enabled:
type: boolean
max:
type: number
min:
type: number
googleCalendar:
type: object
properties:
id:
type: string
twoWaySyncEnabled:
type: boolean
id:
type: string
format: uuid
description: >-
Resource id. Optional client-provided id may be sent on public
create; server behavior may ignore it.
image:
type: object
description: Image upload descriptor for creates. Responses use `imageUrl`.
properties:
key:
type: string
imageUrl:
readOnly: true
type: string
kisiGroupRef:
type: number
locale:
readOnly: true
type: string
locationRef:
format: uuid
type: string
description: >-
Location (organization) id. On public create use `locationRef`, not
`organizationRef`.
money:
type: object
properties:
enabled:
type: boolean
price:
type: number
description: Optional display price; tier data is authoritative.
tiers:
type: array
items:
type: object
properties:
flatAmount:
type: number
from:
type: number
unitAmount:
type: number
upTo:
type: integer
networkRef:
readOnly: true
format: uuid
type: string
parentRef:
type: string
format: uuid
description: Parent room id when creating a child resource.
plans:
type: object
properties:
enabled:
type: boolean
tiers:
type: array
items:
type: object
description: >-
Create payloads use flat tier fields; responses may nest
details under `plan`.
properties:
entire:
type: boolean
plan:
type: object
properties:
commitmentCycles:
type: number
credits:
type: number
dayPasses:
type: number
discounts:
$ref: '#/components/schemas/productTypeDiscountPercentages'
grantedDiscounts:
description: Coupons granted to members on this tier.
type: array
items:
$ref: '#/components/schemas/grantedDiscount'
id:
type: string
format: uuid
period:
type: string
enum:
- day
- week
- month
- threeMonths
- sixMonths
- year
price:
type: number
title:
type: string
commitmentCycles:
type: number
credits:
type: number
dayPasses:
type: number
description:
type: string
discounts:
$ref: '#/components/schemas/productTypeDiscountPercentages'
grantedDiscounts:
description: Coupons granted to members on this tier.
type: array
items:
$ref: '#/components/schemas/grantedDiscount'
ezeepBlueGroupRef:
type: string
id:
type: string
format: uuid
period:
type: string
price:
type: number
selfSignupType:
type: string
setupFee:
type: number
title:
type: string
preparationMinutes:
type: string
enum:
- zeroMinutes
- fiveMinutes
- tenMinutes
- fifteenMinutes
- thirtyMinutes
- sixtyMinutes
refundThreshold:
type: string
enum:
- noRefund
- zeroMinutes
- fifteenMinutes
- thirtyMinutes
- oneHour
- twoHours
- fourHours
- sixHours
- twelveHours
- oneDay
- twoDays
- oneWeek
- twoWeeks
- fourWeeks
saltoksAccessGroupRef:
type: string
format: uuid
schedule:
type: object
description: Default and public availability windows.
properties:
default:
type: object
properties:
closedDays:
type: array
items:
type: string
items:
type: array
items:
type: object
properties:
days:
type: object
properties:
friday:
type: boolean
monday:
type: boolean
saturday:
type: boolean
sunday:
type: boolean
thursday:
type: boolean
tuesday:
type: boolean
wednesday:
type: boolean
hours:
type: object
properties:
from:
type: string
to:
type: string
enabled:
type: boolean
public:
type: object
properties:
closedDays:
type: array
items:
type: string
enabled:
type: boolean
items:
type: array
items:
type: object
properties:
days:
type: object
properties:
friday:
type: boolean
monday:
type: boolean
saturday:
type: boolean
sunday:
type: boolean
thursday:
type: boolean
tuesday:
type: boolean
wednesday:
type: boolean
hours:
type: object
properties:
from:
type: string
to:
type: string
tapkeyGroupRef:
type: string
format: uuid
title:
type: string
minLength: 1
type:
type: string
enum:
- dedicatedDesk
- equipment
- hotDesk
- office
- parkingLot
- room
visibility:
type: string
enum:
- admins
- exclusiveMembers
- members
- networkMembers
- public
responseError:
type: object
properties:
message:
type: string
type:
type: string
productTypeDiscountPercentages:
type: object
description: Synthetic discount percentages by product type.
deprecated: true
properties:
creditPackages:
description: Discount percentage applied to credit packages.
type: number
desks:
description: Discount percentage applied to desk bookings.
type: number
equipment:
description: Discount percentage applied to equipment bookings.
type: number
events:
description: Discount percentage applied to event tickets.
type: number
rooms:
description: Discount percentage applied to room bookings.
type: number
shop:
description: Discount percentage applied to shop products.
type: number
grantedDiscountWritable:
type: object
description: Coupon to grant to a plan tier.
properties:
coupon:
description: Coupon to grant.
type: object
properties:
amountOff:
description: Fixed discount amount.
type: number
currencyCode:
description: Currency code for amountOff.
type: string
id:
description: Unique identifier of the coupon.
type: string
format: uuid
percentOff:
description: Percentage discount.
type: number
productTypes:
description: Product types the coupon applies to.
type: array
items:
type: string
enum:
- roomBookings
- eventSpaceBookings
- conferenceRoomBookings
- meetingRoomBookings
- phoneBoothBookings
- stationBookings
- studioBookings
- hotDeskBookings
- dedicatedDeskBookings
- parkingBookings
- equipmentBookings
- eventTickets
- shopProducts
- packages
- subscriptionItems
required:
- id
dateSchema:
format: date-time
type: string
description: The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z
grantedDiscount:
type: object
description: Coupon granted to a plan, tier, or subscription item.
properties:
coupon:
description: Granted coupon details.
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:
description: Unique identifier of the coupon.
type: string
format: uuid
limitedItems:
description: Item-level redemption limits.
type: object
properties:
enabled:
description: Whether item-level limits are enabled.
type: boolean
values:
description: Limited item values.
type: array
items:
type: object
properties:
id:
description: Unique identifier of the limited item.
type: string
format: uuid
title:
description: Display name of the limited item.
type: string
limitedRedemption:
description: Redemption limits.
type: object
properties:
enabled:
description: Whether redemption limits are enabled.
type: boolean
usage:
description: Current redemption count.
type: number
value:
description: Maximum redemption count.
type: number
percentOff:
description: Percentage discount.
type: number
productTypes:
description: Product types the coupon applies to.
type: array
items:
type: string
enum:
- roomBookings
- eventSpaceBookings
- conferenceRoomBookings
- meetingRoomBookings
- phoneBoothBookings
- stationBookings
- studioBookings
- hotDeskBookings
- dedicatedDeskBookings
- parkingBookings
- equipmentBookings
- eventTickets
- shopProducts
- packages
- subscriptionItems
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 invoices
invoices: Read and write 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
````