> ## 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 tickets
> Retrieve all event tickets. OAuth
Required scopes: events.readonly or events
## OpenAPI
````yaml /assets/openapi.json get /events/tickets/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:
/events/tickets/v1:
get:
tags:
- Events
summary: Retrieve tickets
description: >-
Retrieve all event tickets. OAuth
Required scopes:
events.readonly or events
operationId: getEventTickets
parameters:
- name: locationRef
in: query
description: The id of the location.
schema:
type: string
format: uuid
required: true
- 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.
- 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:
tickets:
type: array
items:
$ref: '#/components/schemas/eventTicket'
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:
- events.readonly
- events
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.
eventTicket:
type: object
properties:
checkInDate:
description: ISO timestamp of when the attendee checked in.
type: string
format: date-time
createDate:
description: ISO timestamp of when the ticket was created.
type: string
format: date-time
deleteDate:
description: ISO timestamp of when the ticket was deleted.
type: string
format: date-time
event:
description: Event this ticket belongs to.
type: object
properties:
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
location:
description: Location where the event is hosted.
type: object
properties:
id:
description: ID 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
media:
description: Media files of 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
startDate:
description: ISO timestamp of when the event starts.
type: string
format: date-time
title:
description: Display name of the event.
type: string
venue:
description: Venue name or address within the location.
type: string
visibilityType:
description: Who can see this event.
type: string
enum:
- public
- admins
- networkMembers
- members
required:
- endDate
- id
- location
- media
- startDate
- title
additionalProperties: false
id:
description: Unique identifier of the event ticket.
type: string
format: uuid
locationRef:
description: ID of the location where the event is hosted.
type: string
format: uuid
membershipRef:
description: ID of the membership associated with this ticket.
type: string
format: uuid
payment:
description: Payment details. Visible to ticket owner and location admins only.
type: object
properties:
createDate:
description: ISO timestamp of when the payment was created.
type: string
format: date-time
discounts:
description: Applied discounts.
type: array
items:
type: object
properties:
coupon:
type: object
properties:
amountOff:
description: Fixed discount amount.
type: number
currencyCode:
description: Currency of the fixed discount.
type: string
id:
description: Coupon ID.
type: string
format: uuid
percentOff:
description: Percentage discount.
type: number
type:
description: Coupon type.
type: string
additionalProperties: false
promocode:
type: object
properties:
code:
description: Promocode string.
type: string
expiration:
description: Expiration date.
type: object
properties:
date:
type: string
enabled:
type: boolean
required:
- enabled
additionalProperties: false
id:
description: Promocode ID.
type: string
format: uuid
limitByFirstPurchase:
type: boolean
additionalProperties: false
subscriptionId:
description: Subscription that granted the discount.
type: string
format: uuid
additionalProperties: false
dispute:
description: Dispute information if applicable.
type: object
properties:
createDate:
description: ISO timestamp of when the dispute was created.
type: string
format: date-time
required:
- createDate
additionalProperties: false
invoiceItemRef:
description: ID of the invoice item (invoice payment type only).
type: string
format: uuid
method:
description: Payment method details.
type: object
properties:
credits:
description: Credits method details.
type: object
properties:
customer:
type: object
properties:
id:
description: ID of the company or membership.
type: string
format: uuid
location:
description: Location associated with the customer.
type: object
properties:
id:
description: ID of the location.
type: string
format: uuid
title:
description: Display name of the location.
type: string
required:
- id
- title
additionalProperties: false
name:
description: First name (membership customer).
type: string
surname:
description: Last name (membership customer).
type: string
title:
description: Company title (company customer).
type: string
type:
description: Customer type.
type: string
enum:
- company
- membership
additionalProperties: false
required:
- customer
additionalProperties: false
external:
description: External payment method details.
type: object
properties:
customer:
type: object
properties:
id:
description: ID of the company or membership.
type: string
format: uuid
location:
description: Location associated with the customer.
type: object
properties:
id:
description: ID of the location.
type: string
format: uuid
title:
description: Display name of the location.
type: string
required:
- id
- title
additionalProperties: false
name:
description: First name (membership customer).
type: string
surname:
description: Last name (membership customer).
type: string
title:
description: Company title (company customer).
type: string
type:
description: Customer type.
type: string
enum:
- company
- membership
additionalProperties: false
location:
type: object
properties:
id:
description: ID of the location.
type: string
format: uuid
title:
description: Display name of the location.
type: string
required:
- id
- title
additionalProperties: false
required:
- customer
- location
additionalProperties: false
invoice:
description: Invoice method details.
type: object
properties:
customer:
type: object
properties:
id:
description: ID of the company or membership.
type: string
format: uuid
location:
description: Location associated with the customer.
type: object
properties:
id:
description: ID of the location.
type: string
format: uuid
title:
description: Display name of the location.
type: string
required:
- id
- title
additionalProperties: false
name:
description: First name (membership customer).
type: string
surname:
description: Last name (membership customer).
type: string
title:
description: Company title (company customer).
type: string
type:
description: Customer type.
type: string
enum:
- company
- membership
additionalProperties: false
required:
- customer
additionalProperties: false
paymentGateway:
description: Payment gateway method details.
type: object
properties:
customer:
type: object
properties:
id:
description: ID of the company or membership.
type: string
format: uuid
location:
description: Location associated with the customer.
type: object
properties:
id:
description: ID of the location.
type: string
format: uuid
title:
description: Display name of the location.
type: string
required:
- id
- title
additionalProperties: false
name:
description: First name (membership customer).
type: string
surname:
description: Last name (membership customer).
type: string
title:
description: Company title (company customer).
type: string
type:
description: Customer type.
type: string
enum:
- company
- membership
additionalProperties: false
label:
description: >-
Human-readable label of the payment method (e.g. 'Visa
4242').
type: string
location:
type: object
properties:
id:
description: ID of the location.
type: string
format: uuid
title:
description: Display name of the location.
type: string
required:
- id
- title
additionalProperties: false
mask:
description: Masked payment method identifier.
type: string
title:
description: Payment gateway title.
type: string
type:
description: Payment gateway type identifier.
type: string
required:
- customer
- location
additionalProperties: false
type:
description: Payment method type.
type: string
enum:
- credits
- invoice
- external
- paymentGateway
required:
- type
additionalProperties: false
price:
description: Amount paid.
type: object
properties:
credits:
description: Credits price breakdown.
type: object
properties:
expiringAmount:
description: Amount of expiring credits paid.
type: number
permanentAmount:
description: Amount of permanent credits paid.
type: number
required:
- expiringAmount
- permanentAmount
additionalProperties: false
money:
description: Money price breakdown.
type: object
properties:
currencyCode:
description: ISO 4217 currency code.
type: string
grossAmount:
description: Gross amount paid.
type: number
required:
- currencyCode
- grossAmount
additionalProperties: false
type:
description: Price type.
type: string
enum:
- credits
- money
required:
- type
additionalProperties: false
refund:
description: Refund details if refunded.
type: object
properties:
credits:
type: object
properties:
amountExpiring:
type: number
amountPermanent:
type: number
amountTotal:
type: number
createDate:
type: string
format: date-time
required:
- amountExpiring
- amountPermanent
- amountTotal
- createDate
additionalProperties: false
money:
type: object
properties:
createDate:
type: string
format: date-time
currencyCode:
type: string
grossAmount:
type: number
required:
- createDate
- currencyCode
- grossAmount
additionalProperties: false
transactionRef:
type: string
format: uuid
additionalProperties: false
refundable:
description: Whether this ticket can be refunded.
type: boolean
refunds:
description: Full list of refunds.
type: object
properties:
credits:
type: array
items:
type: object
properties:
amountExpiring:
type: number
amountPermanent:
type: number
amountTotal:
type: number
createDate:
type: string
format: date-time
id:
type: string
format: uuid
required:
- amountExpiring
- amountPermanent
- amountTotal
- createDate
- id
additionalProperties: false
money:
type: array
items:
type: object
properties:
createDate:
type: string
format: date-time
currencyCode:
type: string
grossAmount:
type: number
id:
type: string
format: uuid
required:
- createDate
- currencyCode
- grossAmount
additionalProperties: false
type:
type: string
enum:
- credits
- money
required:
- type
additionalProperties: false
request:
description: >-
Pending payment request. Present when payment is pending and
belongs to the current user.
type: object
properties:
id:
type: string
format: uuid
url:
description: URL to complete the pending payment.
type: string
required:
- id
- url
additionalProperties: false
status:
description: Payment status.
type: string
enum:
- succeeded
- pending
- processing
- canceled
- failed
surcharge:
description: Surcharge applied to the payment.
type: object
properties:
money:
type: object
properties:
amount:
type: number
currencyCode:
type: string
percentage:
type: number
rate:
type: number
required:
- amount
- currencyCode
- percentage
- rate
additionalProperties: false
type:
type: string
enum:
- money
required:
- money
- type
additionalProperties: false
transactionRef:
description: ID of the associated transaction.
type: string
format: uuid
type:
description: Payment type.
type: string
enum:
- credits
- external
- flow
- fondy
- freedompay
- invoice
- kakaopay
- maya
- mercadopago
- mollie
- paypal
- paystack
- plata
- stripe
- tap
- wayforpay
required:
- discounts
- method
- price
- refundable
- status
- type
additionalProperties: false
role:
description: Role of the ticket holder.
type: string
enum:
- attendee
- host
user:
description: User who owns this ticket.
type: object
properties:
about:
description: About text of the user.
nullable: true
type: string
email:
description: Email address. Visibility controlled by user settings.
nullable: true
type: string
id:
description: Unique identifier of the user.
type: string
format: uuid
name:
description: First name of the user.
nullable: true
type: string
phoneNumber:
description: Phone number. Visibility controlled by user settings.
nullable: true
type: string
photoUrl:
description: Profile photo URL.
nullable: true
type: string
surname:
description: Last name of the user.
nullable: true
type: string
required:
- id
additionalProperties: false
required:
- createDate
- event
- id
- locationRef
- role
- 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
````