> ## 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 an event
> Retrieve an event. OAuth
Required scopes: events
## OpenAPI
````yaml /assets/openapi.json get /events/v1/{id}
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:
/events/v1/{id}:
get:
tags:
- Events
summary: Retrieve an event
description: 'Retrieve an event. OAuth
Required scopes: events'
operationId: getEvent
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
- in: header
name: spacebring-network-id
schema:
type: string
format: uuid
required: true
description: >-
The id of the network. Required when using bearer token
authentication
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
event:
$ref: '#/components/schemas/event'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- events
- events.readonly
components:
schemas:
event:
type: object
properties:
applicationType:
description: Event application type.
type: string
enum:
- purchase
- none
attendees:
description: Number of current attendees (omitted when showAttendees is false).
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
cancelDate:
description: ISO timestamp of when the event was cancelled.
type: string
format: date-time
confirmationEmail:
description: Confirmation email settings.
type: object
properties:
enabled:
description: Whether a confirmation email is sent to attendees.
type: boolean
template:
description: Custom confirmation email template.
nullable: true
type: string
required:
- enabled
additionalProperties: false
createDate:
description: ISO timestamp of when the event was created.
type: string
format: date-time
customTax:
description: Custom tax settings.
type: object
properties:
enabled:
description: Whether custom tax is enabled.
type: boolean
rate:
description: Custom tax rate in percent.
type: number
required:
- enabled
- rate
additionalProperties: false
deleteDate:
description: ISO timestamp of when the event was deleted.
type: string
format: date-time
description:
description: Full description of the event.
type: string
endDate:
description: ISO timestamp of when the event ends.
type: string
format: date-time
id:
description: Unique identifier of the event.
type: string
format: uuid
imageUrl:
deprecated: true
description: 'URL of the event cover image. Deprecated: use media[0].url instead.'
type: string
format: uri
joined:
description: Whether the current user has joined this event (member client only).
type: boolean
limitedAttendees:
description: Limited attendees settings.
type: object
properties:
enabled:
description: Whether attendee count is limited.
type: boolean
limit:
description: Maximum number of attendees when enabled.
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
required:
- enabled
- limit
additionalProperties: false
locale:
description: Detected language locale of the event description.
type: string
location:
description: Location where the event is hosted.
type: object
properties:
id:
description: Unique identifier of the location.
type: string
format: uuid
timezoneId:
description: Timezone identifier of the location.
type: string
title:
description: Display name of the location.
type: string
required:
- id
- timezoneId
- title
additionalProperties: false
locationRef:
description: ID of the location where the event is hosted.
type: string
format: uuid
media:
description: Media files attached to the event.
type: array
items:
type: object
properties:
key:
description: Storage key of the image.
type: string
url:
description: Public URL of the image.
type: string
additionalProperties: false
networkRef:
description: ID of the network this event belongs to.
type: string
format: uuid
price:
description: Pricing options for the event.
type: object
properties:
credits:
description: Credits pricing.
type: object
properties:
amount:
description: Price in credits.
type: number
amountDiscounted:
description: Member-visible credits price (equals list price).
type: number
enabled:
description: Whether credits payment is enabled.
type: boolean
required:
- amount
- enabled
additionalProperties: false
money:
description: Money pricing.
type: object
properties:
amount:
description: Price in location currency.
type: number
amountDiscounted:
description: >-
Member-visible money price in location currency (equals list
price).
type: number
enabled:
description: Whether money payment is enabled.
type: boolean
required:
- amount
- enabled
additionalProperties: false
required:
- credits
- money
additionalProperties: false
refundThreshold:
description: How far in advance a refund can be requested.
type: string
enum:
- noRefund
- zeroMinutes
- fifteenMinutes
- thirtyMinutes
- oneHour
- twoHours
- fourHours
- sixHours
- twelveHours
- oneDay
- twoDays
- oneWeek
- twoWeeks
- fourWeeks
showAttendees:
description: Whether the attendees list is publicly visible.
type: boolean
startDate:
description: ISO timestamp of when the event starts.
type: string
format: date-time
ticketAvailability:
description: Current ticket availability status.
type: string
enum:
- soldOut
- limited
- available
title:
description: Display name of the event.
type: string
venue:
description: Venue name or address within the location.
nullable: true
type: string
visibility:
description: Who can see this event.
type: string
enum:
- public
- admins
- networkMembers
- members
required:
- confirmationEmail
- createDate
- customTax
- endDate
- id
- limitedAttendees
- location
- locationRef
- media
- networkRef
- price
- showAttendees
- startDate
- ticketAvailability
- title
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 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
````