> ## 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 support tickets. OAuth
Required scopes: support.readonly or support
## OpenAPI
````yaml /assets/openapi.json get /support/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:
/support/tickets/v1:
get:
tags:
- Support
summary: Retrieve tickets
description: >-
Retrieve all support tickets. OAuth
Required scopes:
support.readonly or support
operationId: getSupportTickets
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: membershipRefRequester
description: >-
Filter tickets by requester membership ids. Pass one UUID or
multiple unique comma-separated UUIDs without spaces, e.g. `id` or
`id1,id2,id3`, up to 100. The memberships must exist in the
location. Admins can filter by any requester; other users only by
their own membership.
required: false
schema:
type: string
- in: query
name: nextPageToken
schema:
$ref: '#/components/schemas/nextPageToken'
description: Token to retrieve the next page of results.
- in: query
name: order
description: >-
The order of the tickets. createDate:asc, createDate:desc,
updateDate:asc or updateDate:desc. Default: createDate:desc
required: false
schema:
type: string
- in: query
name: userRefAssignee
description: >-
Filter tickets by assignee user ids. Pass one UUID or multiple
unique comma-separated UUIDs without spaces, e.g. `id` or
`id1,id2,id3`, up to 100. The users must exist. Only admins can
filter by assignee.
required: false
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:
type: object
properties:
nextPageToken:
$ref: '#/components/schemas/nextPageToken'
searchQueryNext:
$ref: '#/components/schemas/searchQueryNext'
tickets:
type: array
items:
$ref: '#/components/schemas/ticket'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/responseError'
security:
- BasicAuth: []
- OAuth2:
- support.readonly
- support
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.
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.
ticket:
type: object
properties:
createDate:
type: string
format: date-time
description: ISO timestamp of when the ticket was created.
description:
type: string
description: Ticket description text.
id:
type: string
format: uuid
description: Unique identifier of the ticket.
locationRef:
type: string
format: uuid
description: ID of the location.
membershipAssignee:
deprecated: true
description: Assignee membership details. Deprecated, use userAssignee instead.
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the membership.
roleType:
type: string
description: Role type of the membership in the location.
type:
type: string
description: Membership type.
user:
description: User associated with the membership.
type: object
properties:
blocked:
type: boolean
description: Whether the user is blocked.
email:
description: Email address when visible to the caller.
type: string
id:
type: string
format: uuid
description: Unique identifier of the user.
name:
description: First name of the user.
nullable: true
type: string
phoneNumber:
description: Phone number when visible to the caller.
type: string
photoUrl:
description: Profile photo URL.
nullable: true
type: string
surname:
description: Surname of the user.
nullable: true
type: string
required:
- id
- photoUrl
additionalProperties: false
required:
- id
- roleType
- type
additionalProperties: false
membershipRefAssignee:
deprecated: true
description: >-
ID of the assignee membership. Deprecated, use userRefAssignee
instead.
type: string
format: uuid
membershipRefRequester:
description: ID of the requester membership.
type: string
format: uuid
membershipRequester:
description: Requester membership details.
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the membership.
roleType:
type: string
description: Role type of the membership in the location.
type:
type: string
description: Membership type.
user:
description: User associated with the membership.
type: object
properties:
blocked:
type: boolean
description: Whether the user is blocked.
email:
description: Email address when visible to the caller.
type: string
id:
type: string
format: uuid
description: Unique identifier of the user.
name:
description: First name of the user.
nullable: true
type: string
phoneNumber:
description: Phone number when visible to the caller.
type: string
photoUrl:
description: Profile photo URL.
nullable: true
type: string
surname:
description: Surname of the user.
nullable: true
type: string
required:
- id
- photoUrl
additionalProperties: false
required:
- id
- roleType
- type
additionalProperties: false
number:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
description: Ticket number within the location.
status:
type: string
enum:
- closed
- inProgress
- new
- solved
description: Ticket status.
statusUpdateDate:
description: ISO timestamp of the last status change.
type: string
format: date-time
type:
type: string
enum:
- access
- accountAndBilling
- bookings
- cleaning
- discriminationAndHarassment
- internet
- mailAndPackages
- noiseAndAcoustics
- offensiveOrObjectionableContent
- other
- printing
- repairAndMaintenance
- temperatureAndVentilation
- websiteAndApp
description: Ticket category type.
updateDate:
description: ISO timestamp of the last update.
type: string
format: date-time
userAssignee:
description: Assignee user details.
nullable: true
type: object
properties:
blocked:
type: boolean
description: Whether the user is blocked.
email:
description: Email address when visible to the caller.
type: string
id:
type: string
format: uuid
description: Unique identifier of the user.
name:
description: First name of the user.
nullable: true
type: string
phoneNumber:
description: Phone number when visible to the caller.
type: string
photoUrl:
description: Profile photo URL.
nullable: true
type: string
surname:
description: Surname of the user.
nullable: true
type: string
required:
- id
- photoUrl
additionalProperties: false
userRefAssignee:
description: ID of the assignee user.
type: string
format: uuid
userRequester:
description: Requester user details.
nullable: true
type: object
properties:
blocked:
type: boolean
description: Whether the user is blocked.
email:
description: Email address when visible to the caller.
type: string
id:
type: string
format: uuid
description: Unique identifier of the user.
name:
description: First name of the user.
nullable: true
type: string
phoneNumber:
description: Phone number when visible to the caller.
type: string
photoUrl:
description: Profile photo URL.
nullable: true
type: string
surname:
description: Surname of the user.
nullable: true
type: string
required:
- id
- photoUrl
additionalProperties: false
required:
- createDate
- description
- id
- locationRef
- number
- status
- type
- updateDate
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
````