> ## 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 all locations
> Retrieve all locations. OAuth
Required scopes: locations.readonly or locations
## OpenAPI
````yaml /assets/openapi.json get /locations/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:
/locations/v1:
get:
tags:
- Locations
summary: Retrieve all locations
description: >-
Retrieve all locations. OAuth
Required scopes:
locations.readonly or locations
operationId: getLocations
parameters:
- in: header
name: spacebring-network-id
schema:
type: string
format: uuid
required: false
description: >-
The id of the network. Required when using bearer token
authentication
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
locations:
type: array
items:
$ref: '#/components/schemas/location'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- locations.readonly
- locations
components:
schemas:
location:
type: object
properties:
address:
type: string
businessAddress:
description: >-
Returned only to client credentials and to users with an admin role
in the location.
type: object
properties:
city:
type: string
countryCode:
nullable: true
type: string
line1:
type: string
line2:
type: string
postalCode:
type: string
state:
type: string
createDate:
$ref: '#/components/schemas/dateSchema'
currencyCode:
type: string
description:
type: string
email:
format: email
type: string
id:
type: string
format: uuid
legalName:
description: >-
Returned only to client credentials and to users with an admin role
in the location.
type: string
locale:
type: string
enum:
- en
- es
- ko
- uk
- ru
media:
description: Images of the location, newest first.
type: array
items:
type: object
properties:
height:
type: integer
key:
description: Storage key of the image.
type: string
mime:
type: string
url:
description: Public URL of the image.
type: string
width:
type: integer
networkRef:
type: string
format: uuid
schedule:
description: Opening hours of the location.
type: object
properties:
default:
description: Opening hours for members. Always applies.
type: object
properties:
closedDays:
type: array
items:
type: string
format: date
items:
type: array
items:
type: object
properties:
days:
type: object
properties:
friday:
type: boolean
monday:
type: boolean
saturday:
type: boolean
sunday:
type: boolean
thursday:
type: boolean
tuesday:
type: boolean
wednesday:
type: boolean
hours:
type: object
properties:
from:
type: string
to:
type: string
public:
description: >-
Stricter opening hours for non-members. Applies only when
enabled; otherwise non-members follow the default schedule.
type: object
properties:
closedDays:
type: array
items:
type: string
format: date
enabled:
type: boolean
items:
type: array
items:
type: object
properties:
days:
type: object
properties:
friday:
type: boolean
monday:
type: boolean
saturday:
type: boolean
sunday:
type: boolean
thursday:
type: boolean
tuesday:
type: boolean
wednesday:
type: boolean
hours:
type: object
properties:
from:
type: string
to:
type: string
taxId:
description: >-
Returned only to client credentials and to users with an admin role
in the location.
type: string
timezoneId:
$ref: '#/components/schemas/timezoneId'
title:
type: string
responseError:
type: object
properties:
message:
type: string
type:
type: string
dateSchema:
format: date-time
type: string
description: The date and time in ISO 8601 format, e.g. 2021-05-21T10:00:00Z
timezoneId:
type: string
description: Timezone identifier for the location (e.g. 'Europe/Kyiv')
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
````