> ## 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 benefits
> Retrieve all benefits in the location. OAuth
Required scopes: benefits.readonly or benefits
## OpenAPI
````yaml /assets/openapi.json get /benefits/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:
/benefits/v1:
get:
tags:
- Benefits
summary: Retrieve benefits
description: >-
Retrieve all benefits in the location. OAuth
Required scopes:
benefits.readonly or benefits
operationId: getBenefits
parameters:
- in: query
name: categoryRef
required: false
description: UUID of the benefit category.
schema:
type: string
format: uuid
- in: query
name: featured
required: false
description: Filter by featured status. Pass true or false.
schema:
type: boolean
- in: query
name: limit
required: false
description: >-
Maximum number of benefits 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.
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: 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/getBenefits'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- benefits.readonly
- benefits
components:
schemas:
getBenefits:
type: object
properties:
benefits:
type: array
items:
type: object
properties:
application:
type: object
properties:
allowance:
type: string
enum:
- once
- unlimited
description: >-
How often a user can apply: 'once' limits to a single use,
'unlimited' allows repeated use.
buttonLabel:
type: string
enum:
- apply
- buy
- contact
- get
- learnMore
description: Label on the call-to-action button.
confirmationEmail:
type: object
properties:
enabled:
type: boolean
description: Whether a confirmation email is sent after applying.
template:
type: string
description: HTML template for the confirmation email.
required:
- enabled
- template
additionalProperties: false
enabled:
type: boolean
description: Whether the application flow is enabled for this benefit.
required:
- allowance
- buttonLabel
- confirmationEmail
- enabled
additionalProperties: false
description: Settings controlling how users apply for this benefit.
categoryRef:
type: string
format: uuid
description: ID of the benefit category this benefit belongs to.
createDate:
type: string
format: date-time
description: ISO timestamp of when the benefit was created.
description:
type: string
description: Full description of the benefit.
featured:
type: boolean
description: Whether the benefit is highlighted in listings.
id:
type: string
format: uuid
description: Unique identifier of the benefit.
locale:
type: string
description: Auto-detected language of the description.
locationRef:
type: string
format: uuid
description: ID of the location this benefit is associated with.
media:
type: array
items:
type: object
properties:
key:
type: string
description: Storage key of the media file.
url:
type: string
description: Public URL of the media file.
required:
- key
- url
additionalProperties: false
description: Media files attached to this benefit.
networkRef:
type: string
format: uuid
description: ID of the network this benefit belongs to.
subtitle:
type: string
description: Short tagline displayed below the title.
title:
type: string
description: Display name of the benefit.
updateDate:
description: ISO timestamp of the last update.
type: string
format: date-time
visibility:
type: string
enum:
- public
- admins
- members
- networkMembers
description: >-
Who can see this benefit: 'public' (everyone), 'admins',
'members', or 'networkMembers'.
required:
- application
- categoryRef
- createDate
- description
- featured
- id
- locale
- locationRef
- media
- networkRef
- subtitle
- title
- visibility
additionalProperties: false
description: List of benefits.
nextPageToken:
description: Pagination token to fetch the next page of results.
type: string
searchQueryNext:
description: >-
Search query parameters for the next page of results. Includes all
filters used to fetch the current page.
type: string
required:
- benefits
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/api-reference/authentication#basic-authentication)
for how to authorize your requests
scheme: basic
OAuth2:
type: oauth2
description: >-
See our [authentication
documentation](https://www.spacebring.com/docs/api-reference/authentication#oauth2)
for how to authorize your requests
flows:
authorizationCode:
authorizationUrl: https://api.spacebring.com/oauth2/authorize
tokenUrl: https://api.spacebring.com/oauth2/token
refreshUrl: https://api.spacebring.com/oauth2/token
scopes:
benefits.readonly: Read benefits and applications
benefits: Read and write benefits and applications
community.readonly: Read community companies and memberships
community: Read and write community companies and memberships
events.readonly: Read events and tickets
events: Read and write events and tickets
feed.readonly: Read feed posts
feed: Read and write feed posts
invoices.readonly: Read contracts, credit notes, discounts and invoices
invoices: Read and write contract, credit notes, discounts and invoices
locations.readonly: Read locations
locations: Read and write locations
plans.readonly: Read plans
plans: Read and write plans
resources.readonly: Read resources and bookings
resources: Read and write resources and bookings
subscriptions.readonly: Read subscriptions
subscriptions: Read and write subscriptions
shop.readonly: Read products and orders
shop: Read and write products and orders
support.readonly: Read support tickets
support: Read and write support tickets
transactions.readonly: Read transactions
transactions: Read and write transactions
visitors.readonly: Read visitors
visitors: Read and write visitors
````