logo
API docs by Redocly

Spacebring (andcards)

Download OpenAPI specification:Download

E-mail: op@spacebring.com License: Spacebring Terms of Use

The Spacebring API is built on REST principles. We enforce HTTPS in every request to improve data security, integrity, and privacy.

Before using Spacebring API, please take a moment to familiarize yourself with the product and terminology on Spacebring website.

If you want to be notified about API updates, please subscribe to our newsletter.

Benefits

"Benefit" resource represents a benefit in a certain location.

Retrieve benefits

Retrieve all benefits in the location.

Authorizations:
OAuth2ClientCredentials
query Parameters
organizationRef
required
string <uuid>

The id of the location

Responses

Response samples

Content type
application/json
{
  • "benefits": [
    ]
}

Benefit Applications

"Benefit Applications" resource represents an application for a benefit in a certain location.

Retrieve benefit applications

Retrieve all benefit applications in the location or for certain benefit.

Authorizations:
OAuth2ClientCredentials
query Parameters
organizationRef
string <uuid>

The id of the location

benefitRef
string <uuid>

The id of the benefit

Responses

Response samples

Content type
application/json
{
  • "benefitApplications": [
    ]
}

Companies

"Company" resource represents a company in a certain location.

Retrieve companies

Retrieve all companies.

Authorizations:
OAuth2ClientCredentials
query Parameters
organizationRef
required
string <uuid>

The id of the organization

offset
integer <int64> >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer <int64> [ 1 .. 100 ]
Default: 25

The number of items to return

order
string
Default: "id:asc"

The order of filtered items. Format - field:order. Possible field values are createDate, id, title. Order values - asc, desc.

title
string

Filter by company's title

Responses

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "limit": 0,
  • "offset": 0,
  • "links": {}
}

Create a company

Create a company.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "company": {
    }
}

Response samples

Content type
application/json
{
  • "company": {
    }
}

Retrieve a company

Retrieve a certain company.

Authorizations:
OAuth2ClientCredentials
path Parameters
id
required
string <uuid>

The id of company.

Responses

Response samples

Content type
application/json
{
  • "company": {
    }
}

Update a company

Update a certain company.

Authorizations:
OAuth2ClientCredentials
path Parameters
id
required
string <uuid>

The id of the company.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "company": {
    }
}

Response samples

Content type
application/json
{
  • "company": {
    }
}

Create a subscription

Create a subscription to a certain company.

Authorizations:
OAuth2ClientCredentials
path Parameters
id
required
string <uuid>

The id of the company.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "plan": {
    }
}

Response samples

Content type
application/json
{
  • "company": {
    }
}

Desk Bookings

Spacebring allows to book desks. "Desk Booking" resource represents a booking of a desk in a certain location.

Retrieve desk bookings

Retrieve all bookings for a certain desk.

Authorizations:
OAuth2ClientCredentials
query Parameters
deskRef
string <uuid>

The id of the desk. Required if organizationRef is not passed.

organizationRef
string <uuid>

The id of the organization. Required if deskRef is not passed.

userRef
integer <int64>

The id of the user

string or object

The date filter of items.

offset
integer <int64> >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer <int64> [ 1 .. 100 ]
Default: 25

The number of items to return

order
string
Default: "date:asc"

The order of filtered items. Format - field:order. Possible field values are date, createDate, id. Order values - asc, desc.

Responses

Response samples

Content type
application/json
{
  • "deskBookings": [
    ],
  • "limit": 0,
  • "offset": 0,
  • "total": 0,
  • "links": {}
}

Create desk booking

Create a desk booking.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "deskBooking": {
    }
}

Response samples

Content type
application/json
{
  • "deskBooking": {
    }
}

Delete desk booking

Delete a desk booking.

Authorizations:
OAuth2ClientCredentials
path Parameters
id
required
string <uuid>

The id of the desk booking.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Desks

Spacebring allows to book desks. "Desk" resource represents an actual desk in a certain location.

Retrieve desks

Retrieve desks in the organization.

Authorizations:
OAuth2ClientCredentials
query Parameters
organizationRef
required
string <uuid>

The id of the organization.

date
string <date>

Get desks available for booking.

Responses

Response samples

Content type
application/json
{
  • "desks": [
    ]
}

Event Tickets

Spacebring allows to organize events. When users join events, they get an event ticket. The "Event Ticket" resource represents a ticket for an event in a certain location.

Retrieve event tickets

Retrieve all event tickets.

Authorizations:
OAuth2ClientCredentials
query Parameters
organizationRef
required
string <uuid>

The id of the organization.

Responses

Response samples

Content type
application/json
{
  • "eventPasses": [
    ]
}

Feed Posts

Spacebring has a community feed called Feed. Users can create posts on Feed. The "Feed Post" resource represents a post on Feed in a certain location.

Create a Feed post

Create a Feed post.

Authorizations:
OAuth2
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "activity": {
    }
}

Response samples

Content type
application/json
{
  • "activity": {
    }
}

Invoices

Spacebring has a built-in invoicing system. The "Invoice" resource represents an invoice issued for a member or a company in a certain location.

Retrieve invoices

Retrieve all invoices based on certain parameters.

Authorizations:
OAuth2ClientCredentials
query Parameters
companyRef
string <uuid>

The id of the company

membershipRef
integer <int64>

The id of the membership

organizationRef
string <uuid>

The id of the organization

object

The readyDate filter of items.

offset
integer <int64> >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer <int64> [ 1 .. 100 ]
Default: 25

The number of items to return

order
string
Default: "id:asc"

The order of filtered items. Format - field:order. Possible field values are createDate, id, readyDate. Order values - asc, desc.

status
string
Enum: "active" "inactive" "ready" "voided"

The status of an invoice.

Responses

Response samples

Content type
application/json
{
  • "bills": [
    ],
  • "limit": 0,
  • "offset": 0,
  • "links": {}
}

Create an invoice

Create an invoice for a member or a company.

Authorizations:
OAuth2
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "bill": {
    }
}

Response samples

Content type
application/json
{
  • "bill": {
    }
}

Retrieve an invoice

Retrieve a certain invoice.

Authorizations:
OAuth2ClientCredentials
path Parameters
id
required
string <uuid>

The id of an invoice.

Responses

Response samples

Content type
application/json
{
  • "bill": {
    }
}

Pay an invoice with a given id

Mark an invoice as paid by "External Payment." Learn more about External Payment

Authorizations:
OAuth2ClientCredentials
path Parameters
id
required
string <uuid>

The id of an invoice

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "payment": {
    }
}

Response samples

Content type
application/json
{
  • "transaction": {
    }
}

Invoice Items

"Invoice Item" resource represents an item of an invoice.

Create a invoice item

Create an item in an invoice.

Authorizations:
OAuth2
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "billItem": {
    }
}

Response samples

Content type
application/json
{
  • "billItem": {
    }
}

Locations

Spacebring supports multiple locations. The "Location" resource represents a location on Spacebring.

Retrieve all locations.

Authorizations:
OAuth2ClientCredentials
query Parameters
networkRef
string <uuid>

The id of the network.

role
string
Enum: "admin" "member"

Filter by user permission in organization.

Responses

Response samples

Content type
application/json
{
  • "organizations": [
    ]
}

Membership Requests

When users request to join a certain location, Spacebring creates a request for administrators to approve or reject. The "Membership Request" resource represents such a request to join a certain location.

Retrieve requests to join

Retrieve requests to join the organization.

Authorizations:
OAuth2ClientCredentials
query Parameters
organizationRef
required
string <uuid>

The id of the organization.

Responses

Response samples

Content type
application/json
{
  • "membershipRequests": [
    ]
}

Memberships

When users join a certain location, they obtain membership there (become members). The "Membership" resource represents a mutual connection between a member and a certain location.

Retrieve memberships

Retrieve all memberships.

Authorizations:
OAuth2ClientCredentials
query Parameters
organizationRef
required
string <uuid>

The id of the organization

offset
integer <int64> >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer <int64> [ 1 .. 100 ]
Default: 25

The number of items to return

order
string
Default: "id:asc"

The order of filtered items. Format - field:order. Possible field values are createDate, deleteDate, id, invitationDate. Order values - asc, desc.

userEmail
string <email>

Filter by user's email

Responses

Response samples

Content type
application/json
{
  • "memberships": [
    ],
  • "limit": 0,
  • "offset": 0,
  • "links": {}
}

Create a membership

Create a membership and send an email invitation to join.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "membership": {
    }
}

Response samples

Content type
application/json
{
  • "membership": {
    }
}

Retrieve deleted memberships

Retrieve all deleted memberships.

Authorizations:
OAuth2ClientCredentials
query Parameters
organizationRef
required
string <uuid>

The id of the organization

offset
integer <int64> >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer <int64> [ 1 .. 100 ]
Default: 25

The number of items to return

order
string
Default: "id:asc"

The order of filtered items. Format - field:order. Possible field values are createDate, deleteDate, id, invitationDate. Order values - asc, desc.

userEmail
string <email>

Filter by user's email

Responses

Response samples

Content type
application/json
{
  • "memberships": [
    ],
  • "limit": 0,
  • "offset": 0,
  • "links": {}
}

Retrieve a membership

Retrieve a certain membership.

Authorizations:
OAuth2ClientCredentials
path Parameters
id
required
integer <int64>

The id of membership.

Responses

Response samples

Content type
application/json
{
  • "membership": {
    }
}

Delete a membership

Delete a certain membership.

Authorizations:
OAuth2ClientCredentials
path Parameters
id
required
integer <int64>

The id of the membership.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Update a membership

Update a certain membership.

Authorizations:
OAuth2ClientCredentials
path Parameters
id
required
integer <int64>

The id of the membership.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "membership": {
    }
}

Response samples

Content type
application/json
{
  • "membership": {
    }
}

Create a subscription

Create a subscription to a certain membership.

Authorizations:
OAuth2ClientCredentials
path Parameters
id
required
number

The id of the membership.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "plan": {
    }
}

Response samples

Content type
application/json
{
  • "membership": {
    }
}

Networks

Spacebring allows users to join multiple locations. The "Network" resource represents a network of locations that a user is a member of.

Retrieve networks

Retrieve all networks you are in.

Authorizations:
OAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "networks": [
    ]
}

Retrieve registrations

Retrieve all registrations in network.

Authorizations:
OAuth2ClientCredentials
query Parameters
networkRef
required
string <uuid>

The id of the network

nextPageToken
string <byte>

The starting page to collect the result set

limit
integer <int64> [ 1 .. 100 ]
Default: 25

The number of items to return

Responses

Response samples

Content type
application/json
{
  • "registrations": [
    ],
  • "limit": 0,
  • "nextPageToken": "string",
  • "links": {}
}

Orders

Spacebring allows users to buy products in shop. The "Order" resource represents an actual order for a certain product in shop.

Retrieve orders

Retrieve all orders.

Authorizations:
OAuth2ClientCredentials
query Parameters
organizationRef
required
string <uuid>

The id of the organization

userRef
integer <int64>

The id of the user

object

The date filter of items.

offset
integer <int64> >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer <int64> [ 1 .. 100 ]
Default: 25

The number of items to return

order
string
Default: "createDate:asc"

The order of filtered items. Format - field:order. Possible field values are createDate, id. Order values - asc, desc.

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ],
  • "limit": 0,
  • "offset": 0,
  • "total": 0,
  • "links": {}
}

Products

Spacebring allows users to buy products in shop. The "Products" resource represents an actual product in a certain location.

Retrieve products

Authorizations:
OAuth2ClientCredentials
query Parameters
organizationRef
required
string <uuid>

The id of the location.

Responses

Response samples

Content type
application/json
{
  • "products": [
    ]
}

Update a product

Update a certain product.

Authorizations:
OAuth2ClientCredentials
path Parameters
id
required
string <uuid>

The id of the product.

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "product": {
    }
}

Response samples

Content type
application/json
{
  • "product": {
    }
}

Room Bookings

Spacebring allows users to book meeting rooms. The "Room Booking" resource represents a booking of a room in a certain location.

Retrieve room bookings

Retrieve all room bookings for a certain room.

Authorizations:
OAuth2ClientCredentials
query Parameters
roomRef
string <uuid>

The id of the room. Required if organizationRef is not passed.

organizationRef
string <uuid>

The id of the organization. Required if roomRef is not passed.

userRef
integer <int64>

The id of the user

object

The date filter of items.

object

The date filter of items.

offset
integer <int64> >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer <int64> [ 1 .. 100 ]
Default: 25

The number of items to return

order
string
Default: "endDate:asc"

The order of filtered items. Format - field:order. Possible field values are createDate, endDate, startDate, id. Order values - asc, desc.

Responses

Response samples

Content type
application/json
{
  • "roomBooking": [
    ],
  • "limit": 0,
  • "offset": 0,
  • "total": 0,
  • "links": {}
}

Create room booking

Create a room booking in a certain room.

Authorizations:
OAuth2ClientCredentials
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "roomBooking": {
    }
}

Response samples

Content type
application/json
{
  • "roomBooking": {
    }
}

Delete room booking

Delete a room booking.

Authorizations:
OAuth2ClientCredentials
path Parameters
id
required
string <uuid>

The id of the room booking.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Rooms

Spacebring allows users to book meeting rooms. The "Room" resource represents an actual meeting room in a certain location.

Retrieve rooms

Retrieve rooms in the organization.

Authorizations:
OAuth2ClientCredentials
query Parameters
organizationRef
required
string <uuid>

The id of the organization.

startDate
string <date-time>

Get rooms available for booking. Required if endDate is defined.

endDate
string <date-time>

Get rooms available for booking. Required if startDate is defined.

Responses

Response samples

Content type
application/json
{
  • "rooms": [
    ]
}

Tickets

Spacebring allows users to report issues to administrators. The "Ticket" resource represents a support ticket in a certain location.

Retrieve tickets

Retrieve all tickets.

Authorizations:
OAuth2ClientCredentials
query Parameters
organizationRef
required
string <uuid>

The id of the organization.

offset
integer <int64> >= 0
Default: 0

The number of items to skip before starting to collect the result set

limit
integer <int64> [ 1 .. 100 ]
Default: 25

The number of items to return

order
string
Default: "createDate:desc"

The order of filtered items. Format - field:order. Possible field values are createDate, updateDate. Order values - asc, desc.

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "total": 0,
  • "links": {},
  • "tickets": [
    ]
}

Transactions

When users pay for something on Spacebring, a corresponding transaction is created. The "Transaction" resource represents a payment in a certain location.

Retrieve money transactions

Retrieve money transactions.

Authorizations:
OAuth2ClientCredentials
query Parameters
organizationRef
required
string <uuid>

The id of the organization

limit
integer <int64> [ 1 .. 100 ]
Default: 25

The number of items to return

paymentStatus
string
Enum: "canceled" "failed" "pending" "succeeded"

The payment status of transactions

object

The date filter of items

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "links": {
    }
}

Users

The "User" resource represents a user of your application. Users can perform a variety of actions on Spacebring, such as making a booking, purchase an event ticket, request to join a location, and more.

Search user

Retrieve user by email.

Authorizations:
OAuth2ClientCredentials
query Parameters
email
required
string

The email of user to search.

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Visits

Spacebring allows members to register visitors. The "Visit" resource represents a preliminary registration of a visit in a certain location.

Create a visit

Create a visit.

Authorizations:
OAuth2
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "visit": {
    }
}

Response samples

Content type
application/json
{
  • "visit": {
    }
}