> ## 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. <h3>OAuth</h3>Required scopes: <code>resources.readonly</code> or <code>resources</code>



## 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.
        <h3>OAuth</h3>Required scopes: <code>resources.readonly</code> or
        <code>resources</code>
      operationId: getResources
      parameters:
        - in: query
          name: limit
          required: false
          description: >-
            Maximum number of resources per page. Defaults to 25 when omitted or
            invalid; values above 100 are capped at 100.
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - in: query
          name: locationRef
          required: false
          description: >-
            UUID of the location whose resources to list. Omit to list resources
            across every location of the network.
          schema:
            type: string
            format: uuid
        - in: query
          name: nextPageToken
          required: false
          description: >-
            Pagination token from nextPageToken in a previous response. Keep the
            same filters when fetching the next page.
          schema:
            type: string
        - in: query
          name: type
          required: false
          description: >-
            Resource types to filter by, e.g. `room,hotDesk`. Defaults to all
            bookable types. Comma-separated, one or more of: dedicatedDesk,
            equipment, hotDesk, office, parkingLot, room, station,
            conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio.
          schema:
            type: string
        - in: query
          name: types
          required: false
          description: Deprecated. Use type instead.
          schema:
            deprecated: true
            type: string
        - 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:
                $ref: '#/components/schemas/getResources'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responseError'
      security:
        - BasicAuth: []
        - OAuth2:
            - resources.readonly
            - resources
components:
  schemas:
    getResources:
      type: object
      properties:
        nextPageToken:
          description: Pagination token to fetch the next page of results.
          type: string
        resources:
          type: array
          items:
            type: object
            additionalProperties: false
            properties:
              assignments:
                type: array
                items:
                  type: object
                  properties:
                    company:
                      deprecated: true
                      description: >-
                        Deprecated. Use customer instead. Company assigned to
                        the resource.
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Company id.
                        title:
                          description: >-
                            Company name. Present only for admin callers and the
                            customer's own assignments.
                          type: string
                      required:
                        - id
                      additionalProperties: false
                    customer:
                      description: Customer the resource is assigned to.
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Customer id.
                        logo:
                          description: Company logo when the customer is a company.
                          type: object
                          properties:
                            key:
                              type: string
                            url:
                              type: string
                          required:
                            - key
                            - url
                          additionalProperties: false
                        title:
                          description: Company name when the customer is a company.
                          type: string
                        type:
                          type: string
                          enum:
                            - user
                            - company
                          description: Whether the customer is a user or company.
                        user:
                          description: User details when the customer is a user.
                          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
                            photoUrl:
                              description: Profile photo URL.
                              nullable: true
                              type: string
                            surname:
                              description: User last name.
                              nullable: true
                              type: string
                          required:
                            - id
                          additionalProperties: false
                      required:
                        - id
                        - type
                      additionalProperties: false
                    endDate:
                      description: ISO timestamp when the assignment ends.
                      type: string
                    entire:
                      type: boolean
                      description: >-
                        Whether the assignment grants access to the entire
                        resource.
                    id:
                      description: Assignment id.
                      type: string
                      format: uuid
                    membership:
                      deprecated: true
                      description: >-
                        Deprecated. Use customer instead. 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
                    resource:
                      description: >-
                        Resource the assignment belongs to. Present when
                        assignments are listed on their own.
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Resource id.
                        imageUrl:
                          description: Resource image URL.
                          type: string
                        locationRef:
                          type: string
                          format: uuid
                          description: UUID of the location the resource belongs to.
                        title:
                          type: string
                          description: Resource title.
                        type:
                          type: string
                          description: Resource type.
                      required:
                        - id
                        - locationRef
                        - title
                        - type
                      additionalProperties: false
                    resourceRef:
                      type: string
                      format: uuid
                      description: UUID of the resource the assignment belongs to.
                    startDate:
                      type: string
                      description: ISO timestamp when the assignment starts.
                    subscription:
                      type: object
                      properties:
                        endDate:
                          description: ISO timestamp when the assignment ends.
                          type: string
                        id:
                          description: >-
                            Subscription id. Absent for assignments created
                            directly by an admin.
                          type: string
                          format: uuid
                        startDate:
                          type: string
                          description: ISO timestamp when the assignment starts.
                      required:
                        - startDate
                      additionalProperties: false
                      description: >-
                        Deprecated. Use startDate and endDate instead.
                        Subscription backing this assignment.
                    user:
                      deprecated: true
                      description: >-
                        Deprecated. Use customer instead. 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
                    - startDate
                    - 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
              bookingUnit:
                type: string
                enum:
                  - hour
                  - day
                description: Whether bookings are measured in hours or in whole days.
              bookingWindow:
                type: object
                properties:
                  bookAhead:
                    description: How far ahead users can book the resource.
                    type: string
                    enum:
                      - oneDay
                      - twoDays
                      - oneWeek
                      - twoWeeks
                      - oneMonth
                      - threeMonths
                      - sixMonths
                      - oneYear
                      - unlimited
                  enabled:
                    type: boolean
                    description: >-
                      Whether bookings of the resource are limited by this
                      booking window. While it is false, users can book it up to
                      its start and any time ahead.
                  minNotice:
                    description: >-
                      How many minutes before it starts a booking of the
                      resource has to be made.
                    type: integer
                    minimum: 0
                    maximum: 43200
                  public:
                    type: object
                    properties:
                      bookAhead:
                        description: How far ahead nonmembers can book the resource.
                        type: string
                        enum:
                          - oneDay
                          - twoDays
                          - oneWeek
                          - twoWeeks
                          - oneMonth
                          - threeMonths
                          - sixMonths
                          - oneYear
                          - unlimited
                      enabled:
                        type: boolean
                        description: >-
                          Whether bookings of nonmembers follow a separate
                          booking window.
                      minNotice:
                        description: >-
                          How many minutes before it starts a booking of a
                          nonmember has to be made.
                        type: integer
                        minimum: 0
                        maximum: 43200
                    required:
                      - enabled
                    additionalProperties: false
                    description: >-
                      Booking window for nonmembers. A booking of a nonmember
                      follows it instead of the booking window above while it is
                      enabled, even when that one is off.
                required:
                  - enabled
                  - public
                additionalProperties: false
                description: >-
                  How soon and how far ahead users can book this resource. While
                  enabled is false, users can book it up to its start and any
                  time ahead.
              brivoGroupRef:
                description: Brivo access group reference.
                nullable: true
                type: number
              bufferTime:
                type: string
                enum:
                  - zeroMinutes
                  - fiveMinutes
                  - tenMinutes
                  - fifteenMinutes
                  - thirtyMinutes
                  - sixtyMinutes
                description: >-
                  Time kept free before and after each booking of a room or
                  desk. Other resource types ignore it.
              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 the booking is for an admin.
                  bookingCreatedByMember:
                    type: boolean
                    description: Send confirmation when the booking is for a member.
                  bookingCreatedByNetworkMember:
                    type: boolean
                    description: >-
                      Send confirmation when the booking is for a network
                      member.
                  bookingCreatedByPublic:
                    type: boolean
                    description: Send confirmation when the booking is for a public user.
                  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 once to bookings in this tier.
                        from:
                          type: number
                          description: >-
                            Booking length in minutes at which this tier starts,
                            for example 480 for 8 hours.
                        unit:
                          type: string
                          enum:
                            - hour
                            - day
                          description: Whether the tier is priced per hour or per day.
                        unitAmount:
                          type: number
                          description: >-
                            Price per unit of booking time within this tier,
                            never per minute.
                      required:
                        - flatAmount
                        - from
                        - unit
                        - unitAmount
                      additionalProperties: false
                    description: Stepped credit pricing tiers.
                required:
                  - enabled
                  - tiers
                additionalProperties: false
                description: Credit pricing settings.
              dayPassesEnabled:
                description: >-
                  Whether members can book this resource with day passes. A
                  booking takes one day pass per seat for each day it spans.
                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's cover, the first image in media.
                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 of the resource in display order, the first one being
                  its cover.
              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 once to bookings in this tier.
                        from:
                          type: number
                          description: >-
                            Booking length in minutes at which this tier starts,
                            for example 480 for 8 hours.
                        unit:
                          type: string
                          enum:
                            - hour
                            - day
                          description: Whether the tier is priced per hour or per day.
                        unitAmount:
                          type: number
                          description: >-
                            Price per unit of booking time within this tier,
                            never per minute.
                      required:
                        - flatAmount
                        - from
                        - unit
                        - 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.
              outlookCalendar:
                description: Outlook Calendar integration settings.
                type: object
                properties:
                  id:
                    type: string
                    description: Outlook calendar id.
                  twoWaySyncEnabled:
                    type: boolean
                    description: Whether two-way sync is enabled.
                required:
                  - id
                  - twoWaySyncEnabled
                additionalProperties: false
              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:
                        commitmentCycles:
                          type: number
                          description: Number of billing cycles in the tier.
                        credits:
                          type: number
                          description: Credits included in the tier.
                        crossSells:
                          type: object
                          properties:
                            plans:
                              type: array
                              items:
                                type: string
                                format: uuid
                                description: Plan id.
                              description: Plans offered with the tier, in order.
                          required:
                            - plans
                          additionalProperties: false
                          description: Plans members can buy together with this 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
                                                - officeBookings
                                                - 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
                                        - officeBookings
                                        - 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
                                                    - officeBookings
                                                    - 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
                                            - officeBookings
                                            - 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.
                        selfSignup:
                          type: object
                          properties:
                            contract:
                              description: >-
                                Contract the customer signs to start a
                                subscription from an immediate sign-up. Left out
                                when none is required.
                              type: object
                              properties:
                                templateRef:
                                  type: string
                                  format: uuid
                                  description: ID of the contract template.
                              required:
                                - templateRef
                              additionalProperties: false
                            enabled:
                              type: boolean
                              description: Whether members may self-enroll into the tier.
                            type:
                              type: string
                              description: Self sign-up flow type for the tier.
                          required:
                            - enabled
                            - type
                          additionalProperties: false
                          description: Self sign-up settings of the tier.
                        selfSignupType:
                          deprecated: true
                          description: >-
                            Deprecated. Use selfSignup.type instead. 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:
                        - commitmentCycles
                        - credits
                        - crossSells
                        - entire
                        - grantedDiscounts
                        - id
                        - period
                        - plan
                        - price
                        - selfSignup
                        - 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: Deprecated. Use bufferTime instead.
                deprecated: true
              pricingRules:
                type: array
                items:
                  type: object
                  properties:
                    credits:
                      description: >-
                        Credit prices on the selected days. When omitted, the
                        regular credit tiers apply on them.
                      type: object
                      properties:
                        tiers:
                          type: array
                          items:
                            type: object
                            properties:
                              flatAmount:
                                type: number
                                description: Fixed fee added once to bookings in this tier.
                              from:
                                type: number
                                description: >-
                                  Booking length in minutes at which this tier
                                  starts, for example 480 for 8 hours.
                              unit:
                                type: string
                                enum:
                                  - hour
                                  - day
                                description: >-
                                  Whether the tier is priced per hour or per
                                  day.
                              unitAmount:
                                type: number
                                description: >-
                                  Price per unit of booking time within this
                                  tier, never per minute.
                            required:
                              - flatAmount
                              - from
                              - unit
                              - unitAmount
                            additionalProperties: false
                          description: Stepped credit pricing tiers for the selected days.
                      required:
                        - tiers
                      additionalProperties: false
                    days:
                      type: object
                      properties:
                        friday:
                          type: boolean
                          description: >-
                            Whether the rule applies to bookings starting on a
                            Friday.
                        monday:
                          type: boolean
                          description: >-
                            Whether the rule applies to bookings starting on a
                            Monday.
                        saturday:
                          type: boolean
                          description: >-
                            Whether the rule applies to bookings starting on a
                            Saturday.
                        sunday:
                          type: boolean
                          description: >-
                            Whether the rule applies to bookings starting on a
                            Sunday.
                        thursday:
                          type: boolean
                          description: >-
                            Whether the rule applies to bookings starting on a
                            Thursday.
                        tuesday:
                          type: boolean
                          description: >-
                            Whether the rule applies to bookings starting on a
                            Tuesday.
                        wednesday:
                          type: boolean
                          description: >-
                            Whether the rule applies to bookings starting on a
                            Wednesday.
                      required:
                        - friday
                        - monday
                        - saturday
                        - sunday
                        - thursday
                        - tuesday
                        - wednesday
                      additionalProperties: false
                      description: >-
                        Weekdays, in the location's time zone, on which a
                        booking that starts gets these prices.
                    money:
                      description: >-
                        Money prices on the selected days. When omitted, the
                        regular money tiers apply on them.
                      type: object
                      properties:
                        tiers:
                          type: array
                          items:
                            type: object
                            properties:
                              flatAmount:
                                type: number
                                description: Fixed fee added once to bookings in this tier.
                              from:
                                type: number
                                description: >-
                                  Booking length in minutes at which this tier
                                  starts, for example 480 for 8 hours.
                              unit:
                                type: string
                                enum:
                                  - hour
                                  - day
                                description: >-
                                  Whether the tier is priced per hour or per
                                  day.
                              unitAmount:
                                type: number
                                description: >-
                                  Price per unit of booking time within this
                                  tier, never per minute.
                            required:
                              - flatAmount
                              - from
                              - unit
                              - unitAmount
                            additionalProperties: false
                          description: Stepped money pricing tiers for the selected days.
                      required:
                        - tiers
                      additionalProperties: false
                  required:
                    - days
                  additionalProperties: false
                description: >-
                  Prices that replace the regular money and credit tiers for
                  bookings starting on the selected weekdays. A booking is
                  priced by the rule covering the weekday of its start in the
                  location's time zone, and by the regular tiers when no rule
                  covers it.
              refundPolicy:
                type: object
                properties:
                  partialRefunds:
                    maxItems: 5
                    type: array
                    items:
                      type: object
                      properties:
                        percent:
                          type: integer
                          minimum: 1
                          maximum: 99
                          description: >-
                            Share of what the booking was paid with that is
                            refunded, from 1 to 99.
                        value:
                          type: string
                          enum:
                            - zeroMinutes
                            - fifteenMinutes
                            - thirtyMinutes
                            - oneHour
                            - twoHours
                            - fourHours
                            - sixHours
                            - twelveHours
                            - oneDay
                            - twoDays
                            - oneWeek
                            - twoWeeks
                            - fourWeeks
                          description: >-
                            How long before start the booking must be canceled
                            to get this share back.
                      required:
                        - percent
                        - value
                      additionalProperties: false
                    description: >-
                      Shares refunded when a booking is canceled after the full
                      refund period has ended. A cancellation gets the share of
                      the longest threshold it still meets, and nothing once
                      every threshold has passed. Each threshold is shorter than
                      value, and a shorter threshold refunds a smaller share.
                      Ordered from the longest threshold to the shortest.
                  public:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                        description: >-
                          Whether bookings of nonmembers follow a separate
                          rescheduling policy.
                      partialRefunds:
                        maxItems: 5
                        type: array
                        items:
                          type: object
                          properties:
                            percent:
                              type: integer
                              minimum: 1
                              maximum: 99
                              description: >-
                                Share of what the booking was paid with that is
                                refunded, from 1 to 99.
                            value:
                              type: string
                              enum:
                                - zeroMinutes
                                - fifteenMinutes
                                - thirtyMinutes
                                - oneHour
                                - twoHours
                                - fourHours
                                - sixHours
                                - twelveHours
                                - oneDay
                                - twoDays
                                - oneWeek
                                - twoWeeks
                                - fourWeeks
                              description: >-
                                How long before start the booking must be
                                canceled to get this share back.
                          required:
                            - percent
                            - value
                          additionalProperties: false
                        description: Partial refunds for bookings of nonmembers.
                      value:
                        type: string
                        enum:
                          - noRefund
                          - zeroMinutes
                          - fifteenMinutes
                          - thirtyMinutes
                          - oneHour
                          - twoHours
                          - fourHours
                          - sixHours
                          - twelveHours
                          - oneDay
                          - twoDays
                          - oneWeek
                          - twoWeeks
                          - fourWeeks
                        description: >-
                          How long before start a booking of a nonmember remains
                          refundable.
                    required:
                      - enabled
                      - partialRefunds
                      - value
                    additionalProperties: false
                    description: >-
                      Rescheduling policy for bookings of nonmembers. A booking
                      follows it instead of value when it is enabled.
                  value:
                    type: string
                    enum:
                      - noRefund
                      - zeroMinutes
                      - fifteenMinutes
                      - thirtyMinutes
                      - oneHour
                      - twoHours
                      - fourHours
                      - sixHours
                      - twelveHours
                      - oneDay
                      - twoDays
                      - oneWeek
                      - twoWeeks
                      - fourWeeks
                    description: How long before start a booking remains refundable.
                required:
                  - partialRefunds
                  - public
                  - value
                additionalProperties: false
                description: Rescheduling policy for cancellations and start time changes.
              refundThreshold:
                type: string
                enum:
                  - noRefund
                  - zeroMinutes
                  - fifteenMinutes
                  - thirtyMinutes
                  - oneHour
                  - twoHours
                  - fourHours
                  - sixHours
                  - twelveHours
                  - oneDay
                  - twoDays
                  - oneWeek
                  - twoWeeks
                  - fourWeeks
                description: Deprecated. Use refundPolicy.value instead.
                deprecated: true
              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:
                                  description: >-
                                    Closing time in 24-hour format, counted from
                                    the start of the weekday. A day that stays
                                    open past midnight closes after 24:00, for
                                    example at 26:00 for 2:00 AM the next day,
                                    and at most 24 hours after the opening time.
                                  type: string
                              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:
                                  description: >-
                                    Closing time in 24-hour format, counted from
                                    the start of the weekday. A day that stays
                                    open past midnight closes after 24:00, for
                                    example at 26:00 for 2:00 AM the next day,
                                    and at most 24 hours after the opening time.
                                  type: string
                              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.
              unifiAccessGroupRef:
                description: UniFi Access policy reference.
                nullable: true
                type: string
              visibility:
                type: string
                enum:
                  - admins
                  - exclusiveMembers
                  - members
                  - networkMembers
                  - public
                description: Visibility of the resource.
            required:
              - assignments
              - bookingPermission
              - bookingUnit
              - bookingWindow
              - bufferTime
              - children
              - confirmationEmail
              - createDate
              - credits
              - description
              - duration
              - dynamicPricing
              - id
              - locale
              - locationRef
              - media
              - money
              - networkRef
              - preparationMinutes
              - pricingRules
              - refundPolicy
              - refundThreshold
              - title
              - type
              - visibility
          description: List of resources.
        searchQueryNext:
          description: >-
            Search query parameters for the next page of results. Includes all
            filters used to fetch the current page.
          type: string
      required:
        - resources
      additionalProperties: false
    responseError:
      type: object
      properties:
        message:
          type: string
        type:
          type: string
  securitySchemes:
    BasicAuth:
      type: http
      description: >-
        See our [authentication
        documentation](https://www.spacebring.com/docs/developer/api/authentication#basic-authentication)
        for how to authorize your requests
      scheme: basic
    OAuth2:
      type: oauth2
      description: >-
        See our [authentication
        documentation](https://www.spacebring.com/docs/developer/api/authentication#oauth2)
        for how to authorize your requests
      flows:
        authorizationCode:
          authorizationUrl: https://oauth2.spacebring.com/api/oauth2/authorize
          tokenUrl: https://oauth2.spacebring.com/api/oauth2/token
          refreshUrl: https://oauth2.spacebring.com/api/oauth2/token
          scopes:
            benefits.readonly: Read benefits and applications
            benefits: Read and write benefits and applications
            campaigns.readonly: Read campaigns
            campaigns: Read and write campaigns
            checkIns.readonly: Read check-ins
            checkIns: Read and write check-ins
            community.readonly: Read community companies and memberships
            community: Read and write community companies and memberships
            deliveries.readonly: Read deliveries
            deliveries: Read and write deliveries
            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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.