> ## 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 applications
> Retrieve all benefit applications in the location or for certain benefit. OAuth
Required scopes: benefits.readonly or benefits
## OpenAPI
````yaml /assets/openapi.json get /benefits/applications/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/applications/v1:
get:
tags:
- Benefits
summary: Retrieve applications
description: >-
Retrieve all benefit applications in the location or for certain
benefit. OAuth
Required scopes: benefits.readonly
or benefits
operationId: getBenefitApplications
parameters:
- in: query
name: locationRef
description: The id of the location
schema:
type: string
format: uuid
required: false
- in: query
name: benefitRef
description: The id of the benefit
schema:
type: string
format: uuid
required: false
- in: query
name: limit
schema:
type: integer
format: int64
minimum: 1
maximum: 100
default: 25
description: The number of items to return
- in: query
name: nextPageToken
schema:
$ref: '#/components/schemas/nextPageToken'
description: Token to retrieve the next page of results.
required: false
- in: query
name: categoryRef
schema:
type: array
items:
type: string
format: uuid
description: The ids of the categories to filter by
required: false
- name: userRef
in: query
schema:
type: string
format: uuid
required: false
- in: header
name: spacebring-network-id
schema:
type: string
format: uuid
required: false
description: >-
The id of the network. Required when using bearer token
authentication
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
applications:
type: array
items:
$ref: '#/components/schemas/benefitApplication'
nextPageToken:
$ref: '#/components/schemas/nextPageToken'
searchQueryNext:
$ref: '#/components/schemas/searchQueryNext'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- benefits.readonly
- benefits
components:
schemas:
nextPageToken:
type: string
description: >-
Opaque cursor token for retrieving the next page of results. Pass this
value as the `nextPageToken` query parameter in your next request.
benefitApplication:
type: object
properties:
benefit:
description: Summary of the benefit this application is for.
type: object
properties:
description:
description: Full description of the benefit.
type: string
id:
description: Unique identifier of the benefit.
type: string
format: uuid
mediaUrl:
description: URL of the benefit's cover image.
type: string
format: uri
subtitle:
description: Short tagline of the benefit.
type: string
title:
description: Display name of the benefit.
type: string
required:
- id
- title
additionalProperties: false
comment:
description: Optional comment left by the applicant.
type: string
createDate:
description: ISO timestamp of when the application was submitted.
type: string
format: date-time
id:
description: Unique identifier of the application.
type: string
format: uuid
locationRef:
description: ID of the location where the application was submitted.
type: string
format: uuid
membershipRef:
description: ID of the membership associated with this application.
type: string
format: uuid
number:
description: Human-readable application number.
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
user:
description: The user who submitted the application.
type: object
properties:
about:
description: About text of the user.
type: string
blocked:
description: Whether the user is blocked.
type: boolean
createDate:
description: ISO timestamp of when the user account was created.
type: string
format: date-time
deleteDate:
description: ISO timestamp of when the user account was deleted.
type: string
format: date-time
email:
description: Email address of the user.
type: string
format: email
id:
description: Unique identifier of the user.
type: string
format: uuid
name:
description: First name of the user.
type: string
phoneNumber:
description: Phone number of the user.
type: string
photoUrl:
description: URL of the user's profile photo.
type: string
format: uri
restricted:
description: Whether the user has restricted access.
type: boolean
surname:
description: Last name of the user.
type: string
required:
- blocked
- createDate
- email
- id
- name
- restricted
- surname
additionalProperties: false
required:
- benefit
- createDate
- id
- locationRef
- number
- user
additionalProperties: false
searchQueryNext:
type: string
description: >-
Pre-built query string for the next page of results. Contains all active
filter parameters combined with the next page token, ready to append to
the endpoint URL.
responseError:
type: object
properties:
message:
type: string
type:
type: string
securitySchemes:
BasicAuth:
type: http
description: >-
See our [authentication
documentation](https://www.spacebring.com/docs/api-reference/authentication#basic-authentication)
for how to authorize your requests
scheme: basic
OAuth2:
type: oauth2
description: >-
See our [authentication
documentation](https://www.spacebring.com/docs/api-reference/authentication#oauth2)
for how to authorize your requests
flows:
authorizationCode:
authorizationUrl: https://api.spacebring.com/oauth2/authorize
tokenUrl: https://api.spacebring.com/oauth2/token
refreshUrl: https://api.spacebring.com/oauth2/token
scopes:
benefits.readonly: Read benefits and applications
benefits: Read and write benefits and applications
community.readonly: Read community companies and memberships
community: Read and write community companies and memberships
events.readonly: Read events and tickets
events: Read and write events and tickets
feed.readonly: Read feed posts
feed: Read and write feed posts
invoices.readonly: Read 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
````