Download OpenAPI specification:Download
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.
Retrieve all benefits in the location.
organizationRef required | string <uuid> The id of the location |
{- "benefits": [
- {
- "categoryRef": "52f89543-26de-4bb8-a42b-67d7e501ea89",
- "createDate": "string",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subtitle": "string",
- "title": "string"
}
]
}
"Benefit Applications" resource represents an application for a benefit in a certain location.
Retrieve all benefit applications in the location or for certain benefit.
organizationRef | string <uuid> The id of the location |
benefitRef | string <uuid> The id of the benefit |
{- "benefitApplications": [
- {
- "benefitRef": "a47a104b-be0a-4064-af49-ab2b80afe958",
- "benefit": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "comment": "string",
- "createDate": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "userRef": "3b735c57-590c-47dd-bb6b-a88a177dd4d0",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}
}
]
}
Retrieve all companies.
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 - |
title | string Filter by company's title |
{- "companies": [
- {
- "createDate": "string",
- "credits": {
- "expiring": 0,
- "permanent": 0
}, - "id": "string",
- "metadata": { },
- "organizationRef": "string",
- "plan": {
- "addons": [
- {
- "amount": 0,
- "title": "string"
}
], - "autoInvoice": true,
- "credits": 0,
- "currentInterval": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "discounts": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "payWithInvoice": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "period": "day",
- "price": 0,
- "priceTotal": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "template": {
- "id": "string"
}, - "title": "string"
}, - "title": "string"
}
], - "limit": 0,
- "offset": 0,
}
Create a company.
required | object |
{- "company": {
- "metadata": { },
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "title": "string"
}
}
{- "company": {
- "createDate": "string",
- "credits": {
- "expiring": 0,
- "permanent": 0
}, - "id": "string",
- "metadata": { },
- "organizationRef": "string",
- "plan": {
- "addons": [
- {
- "amount": 0,
- "title": "string"
}
], - "autoInvoice": true,
- "credits": 0,
- "currentInterval": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "discounts": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "payWithInvoice": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "period": "day",
- "price": 0,
- "priceTotal": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "template": {
- "id": "string"
}, - "title": "string"
}, - "title": "string"
}
}
Retrieve a certain company.
id required | string <uuid> The id of company. |
{- "company": {
- "createDate": "string",
- "credits": {
- "expiring": 0,
- "permanent": 0
}, - "id": "string",
- "metadata": { },
- "organizationRef": "string",
- "plan": {
- "addons": [
- {
- "amount": 0,
- "title": "string"
}
], - "autoInvoice": true,
- "credits": 0,
- "currentInterval": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "discounts": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "payWithInvoice": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "period": "day",
- "price": 0,
- "priceTotal": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "template": {
- "id": "string"
}, - "title": "string"
}, - "title": "string"
}
}
Update a certain company.
id required | string <uuid> The id of the company. |
required | object |
{- "company": {
- "metadata": { },
- "title": "string"
}
}
{- "company": {
- "createDate": "string",
- "credits": {
- "expiring": 0,
- "permanent": 0
}, - "id": "string",
- "metadata": { },
- "organizationRef": "string",
- "plan": {
- "addons": [
- {
- "amount": 0,
- "title": "string"
}
], - "autoInvoice": true,
- "credits": 0,
- "currentInterval": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "discounts": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "payWithInvoice": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "period": "day",
- "price": 0,
- "priceTotal": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "template": {
- "id": "string"
}, - "title": "string"
}, - "title": "string"
}
}
Create a subscription to a certain company.
id required | string <uuid> The id of the company. |
required | object |
{- "plan": {
- "addons": [
- {
- "amount": 0,
- "title": "string"
}
], - "autoInvoice": true,
- "credits": 0,
- "discounts": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "payWithInvoice": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "period": "day",
- "price": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "template": {
- "id": "string"
}, - "title": "string"
}
}
{- "company": {
- "createDate": "string",
- "credits": {
- "expiring": 0,
- "permanent": 0
}, - "id": "string",
- "metadata": { },
- "organizationRef": "string",
- "plan": {
- "addons": [
- {
- "amount": 0,
- "title": "string"
}
], - "autoInvoice": true,
- "credits": 0,
- "currentInterval": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "discounts": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "payWithInvoice": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "period": "day",
- "price": 0,
- "priceTotal": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "template": {
- "id": "string"
}, - "title": "string"
}, - "title": "string"
}
}
Spacebring allows to book desks. "Desk Booking" resource represents a booking of a desk in a certain location.
Retrieve all bookings for a certain desk.
deskRef | string <uuid> The id of the desk. Required if |
organizationRef | string <uuid> The id of the organization. Required if |
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 - |
{- "deskBookings": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "date": "2019-08-24T14:15:22Z",
- "desk": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "deskRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "numberOfSeats": 0,
- "seats": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "deleteDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number": 0
}
], - "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
], - "limit": 0,
- "offset": 0,
- "total": 0,
}
Create a desk booking.
required | object |
{- "deskBooking": {
- "date": "2019-08-24T14:15:22Z",
- "deskRef": "string",
- "userRef": "string",
- "numberOfSeats": 0,
- "seats": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}
}
{- "deskBooking": {
- "createDate": "2019-08-24T14:15:22Z",
- "date": "2019-08-24T14:15:22Z",
- "desk": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "deskRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "numberOfSeats": 0,
- "seats": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "deleteDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number": 0
}
], - "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
}
Spacebring allows to book desks. "Desk" resource represents an actual desk in a certain location.
Retrieve desks in the organization.
organizationRef required | string <uuid> The id of the organization. |
date | string <date> Deprecated Get desks available for booking. |
{- "desks": [
- {
- "access": {
- "companies": [
- "string"
], - "isLimited": true,
- "visibility": "admins"
}, - "createDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "price": {
- "credits": 0,
- "currency": "string",
- "money": 0
}, - "numberOfSeats": 0,
- "seats": {
- "createDate": "2019-08-24T14:15:22Z",
- "deleteDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number": 0
}, - "title": "string"
}
]
}
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 all event tickets.
organizationRef required | string <uuid> The id of the organization. |
{- "eventPasses": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "event": {
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
]
}
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.
required | object |
{- "activity": {
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "text": "string"
}
}
{- "activity": {
- "attachments": {
- "images": [
], - "og": { }
}, - "createDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "text": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
}
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 all invoices based on certain 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 - |
status | string Enum: "active" "inactive" "ready" "voided" The status of an invoice. |
{- "bills": [
- {
- "billingAddressBy": "string",
- "billingAddressTo": "string",
- "company": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "companyRef": "string",
- "customerName": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "items": [
- {
- "amount": 0,
- "grossAmount": 0,
- "createDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "deskBooking": {
- "createDate": "2019-08-24T14:15:22Z",
- "date": "2019-08-24T14:15:22Z",
- "desk": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "deskRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "numberOfSeats": 0,
- "seats": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "deleteDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number": 0
}
], - "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "deskBookingRef": "string",
- "eventPass": {
- "createDate": "2019-08-24T14:15:22Z",
- "event": {
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "eventPassRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "plan": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string"
}, - "planRef": "string",
- "quantity": 1,
- "roomBooking": {
- "createDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "memo": "string",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "room": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "roomRef": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "roomBookingRef": "string",
- "serviceApplication": {
- "createDate": "2019-08-24T14:15:22Z",
- "quantity": 0,
- "service": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "serviceRef": "string",
- "serviceOption": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "serviceOptionRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "serviceApplicationRef": "string",
- "status": "excluded",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "type": "custom"
}
], - "membership": {
- "id": 0,
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}
}, - "membershipRef": 0,
- "organization": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "organizationRef": "string",
- "readyDate": "2019-08-24T14:15:22Z",
- "status": "active",
- "title": "string",
- "transaction": {
- "amount": 0,
- "amountType": "money",
- "currency": "string",
- "companyRef": "string",
- "creditsAllocation": {
- "expiring": 0,
- "permanent": 0
}, - "creditsCharge": {
- "expiring": 0,
- "permanent": 0
}, - "billRef": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "deskBookingRef": "string",
- "eventPassRef": "string",
- "id": "string",
- "items": [
- {
- "amount": 0,
- "amountType": "money",
- "currency": "string",
- "grossAmount": 0,
- "deskBookingRef": "string",
- "eventPassRef": "string",
- "id": "string",
- "quantity": 0,
- "roomBookingRef": "string",
- "serviceApplicationRef": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "type": "bill"
}
], - "organizationRef": "string",
- "payment": {
- "flowTokenRef": "string",
- "kakaopayTidRef": "string",
- "payboxPaymentRef": "string",
- "status": "canceled",
- "stripePaymentIntentRef": "string",
- "type": "external",
- "wayforpayOrderRef": "string"
}, - "refund": {
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}, - "type": "bill",
- "roomBookingRef": "string",
- "serviceApplicationRef": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "transactionRef": "string",
- "voidDate": "2019-08-24T14:15:22Z"
}
], - "limit": 0,
- "offset": 0,
}
Create an invoice for a member or a company.
required | object |
{- "bill": {
- "companyRef": "75c4824c-34ea-49c7-bc15-38b73f374457",
- "membershipRef": 0
}
}
{- "bill": {
- "billingAddressBy": "string",
- "billingAddressTo": "string",
- "company": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "companyRef": "string",
- "customerName": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "items": [
- {
- "amount": 0,
- "grossAmount": 0,
- "createDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "deskBooking": {
- "createDate": "2019-08-24T14:15:22Z",
- "date": "2019-08-24T14:15:22Z",
- "desk": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "deskRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "numberOfSeats": 0,
- "seats": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "deleteDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number": 0
}
], - "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "deskBookingRef": "string",
- "eventPass": {
- "createDate": "2019-08-24T14:15:22Z",
- "event": {
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "eventPassRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "plan": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string"
}, - "planRef": "string",
- "quantity": 1,
- "roomBooking": {
- "createDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "memo": "string",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "room": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "roomRef": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "roomBookingRef": "string",
- "serviceApplication": {
- "createDate": "2019-08-24T14:15:22Z",
- "quantity": 0,
- "service": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "serviceRef": "string",
- "serviceOption": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "serviceOptionRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "serviceApplicationRef": "string",
- "status": "excluded",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "type": "custom"
}
], - "membership": {
- "id": 0,
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}
}, - "membershipRef": 0,
- "organization": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "organizationRef": "string",
- "readyDate": "2019-08-24T14:15:22Z",
- "status": "active",
- "title": "string",
- "transaction": {
- "amount": 0,
- "amountType": "money",
- "currency": "string",
- "companyRef": "string",
- "creditsAllocation": {
- "expiring": 0,
- "permanent": 0
}, - "creditsCharge": {
- "expiring": 0,
- "permanent": 0
}, - "billRef": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "deskBookingRef": "string",
- "eventPassRef": "string",
- "id": "string",
- "items": [
- {
- "amount": 0,
- "amountType": "money",
- "currency": "string",
- "grossAmount": 0,
- "deskBookingRef": "string",
- "eventPassRef": "string",
- "id": "string",
- "quantity": 0,
- "roomBookingRef": "string",
- "serviceApplicationRef": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "type": "bill"
}
], - "organizationRef": "string",
- "payment": {
- "flowTokenRef": "string",
- "kakaopayTidRef": "string",
- "payboxPaymentRef": "string",
- "status": "canceled",
- "stripePaymentIntentRef": "string",
- "type": "external",
- "wayforpayOrderRef": "string"
}, - "refund": {
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}, - "type": "bill",
- "roomBookingRef": "string",
- "serviceApplicationRef": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "transactionRef": "string",
- "voidDate": "2019-08-24T14:15:22Z"
}
}
Retrieve a certain invoice.
id required | string <uuid> The id of an invoice. |
{- "bill": {
- "billingAddressBy": "string",
- "billingAddressTo": "string",
- "company": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "companyRef": "string",
- "customerName": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "items": [
- {
- "amount": 0,
- "grossAmount": 0,
- "createDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "deskBooking": {
- "createDate": "2019-08-24T14:15:22Z",
- "date": "2019-08-24T14:15:22Z",
- "desk": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "deskRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "numberOfSeats": 0,
- "seats": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "deleteDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number": 0
}
], - "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "deskBookingRef": "string",
- "eventPass": {
- "createDate": "2019-08-24T14:15:22Z",
- "event": {
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "eventPassRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "plan": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string"
}, - "planRef": "string",
- "quantity": 1,
- "roomBooking": {
- "createDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "memo": "string",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "room": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "roomRef": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "roomBookingRef": "string",
- "serviceApplication": {
- "createDate": "2019-08-24T14:15:22Z",
- "quantity": 0,
- "service": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "serviceRef": "string",
- "serviceOption": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "serviceOptionRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "serviceApplicationRef": "string",
- "status": "excluded",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "type": "custom"
}
], - "membership": {
- "id": 0,
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}
}, - "membershipRef": 0,
- "organization": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "organizationRef": "string",
- "readyDate": "2019-08-24T14:15:22Z",
- "status": "active",
- "title": "string",
- "transaction": {
- "amount": 0,
- "amountType": "money",
- "currency": "string",
- "companyRef": "string",
- "creditsAllocation": {
- "expiring": 0,
- "permanent": 0
}, - "creditsCharge": {
- "expiring": 0,
- "permanent": 0
}, - "billRef": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "deskBookingRef": "string",
- "eventPassRef": "string",
- "id": "string",
- "items": [
- {
- "amount": 0,
- "amountType": "money",
- "currency": "string",
- "grossAmount": 0,
- "deskBookingRef": "string",
- "eventPassRef": "string",
- "id": "string",
- "quantity": 0,
- "roomBookingRef": "string",
- "serviceApplicationRef": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "type": "bill"
}
], - "organizationRef": "string",
- "payment": {
- "flowTokenRef": "string",
- "kakaopayTidRef": "string",
- "payboxPaymentRef": "string",
- "status": "canceled",
- "stripePaymentIntentRef": "string",
- "type": "external",
- "wayforpayOrderRef": "string"
}, - "refund": {
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}, - "type": "bill",
- "roomBookingRef": "string",
- "serviceApplicationRef": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "transactionRef": "string",
- "voidDate": "2019-08-24T14:15:22Z"
}
}
Mark an invoice as paid by "External Payment." Learn more about External Payment
id required | string <uuid> The id of an invoice |
required | object |
{- "payment": {
- "type": "external"
}
}
{- "transaction": {
- "amount": 0,
- "amountType": "money",
- "currency": "string",
- "company": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "companyRef": "string",
- "creditsAllocation": {
- "expiring": 0,
- "permanent": 0
}, - "creditsCharge": {
- "expiring": 0,
- "permanent": 0
}, - "bill": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "billRef": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "deskBooking": {
- "createDate": "2019-08-24T14:15:22Z",
- "date": "2019-08-24T14:15:22Z",
- "desk": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "deskRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "numberOfSeats": 0,
- "seats": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "deleteDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number": 0
}
], - "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "deskBookingRef": "string",
- "eventPass": {
- "createDate": "2019-08-24T14:15:22Z",
- "event": {
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "eventPassRef": "string",
- "id": "string",
- "items": [
- {
- "amountType": "money",
- "currency": "string",
- "grossAmount": 0,
- "deskBookingRef": "string",
- "eventPassRef": "string",
- "id": "string",
- "roomBookingRef": "string",
- "serviceApplicationRef": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "type": "bill"
}
], - "organization": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "organizationRef": "string",
- "payment": {
- "flowTokenRef": "string",
- "kakaopayTidRef": "string",
- "payboxPaymentRef": "string",
- "status": "canceled",
- "stripePaymentIntentRef": "string",
- "type": "external",
- "wayforpayOrderRef": "string"
}, - "refund": {
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}, - "type": "bill",
- "roomBooking": {
- "createDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "memo": "string",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "room": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "roomRef": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "roomBookingRef": "string",
- "serviceApplication": {
- "createDate": "2019-08-24T14:15:22Z",
- "quantity": 0,
- "service": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "serviceRef": "string",
- "serviceOption": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "serviceOptionRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "serviceApplicationRef": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
}
Create an item in an invoice.
required | object |
{- "billItem": {
- "amount": 0,
- "billRef": "0c6aefc3-75bb-4d16-a728-d64f8430724c",
- "description": "string",
- "type": "custom",
- "tax": {
- "rate": 0
}
}
}
{- "billItem": {
- "amount": 0,
- "grossAmount": 0,
- "createDate": "2019-08-24T14:15:22Z",
- "currency": "string",
- "description": "string",
- "deskBooking": {
- "createDate": "2019-08-24T14:15:22Z",
- "date": "2019-08-24T14:15:22Z",
- "desk": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "deskRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "numberOfSeats": 0,
- "seats": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "deleteDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number": 0
}
], - "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "deskBookingRef": "string",
- "eventPass": {
- "createDate": "2019-08-24T14:15:22Z",
- "event": {
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "eventPassRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "plan": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string"
}, - "planRef": "string",
- "quantity": 1,
- "roomBooking": {
- "createDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "memo": "string",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "room": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "roomRef": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}, - "roomBookingRef": "string",
- "serviceApplication": {
- "createDate": "2019-08-24T14:15:22Z",
- "quantity": 0,
- "service": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "serviceRef": "string",
- "serviceOption": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "serviceOptionRef": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}, - "serviceApplicationRef": "string",
- "status": "excluded",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "type": "custom"
}
}
Spacebring supports multiple locations. The "Location" resource represents a location on Spacebring.
networkRef | string <uuid> The id of the network. |
role | string Enum: "admin" "member" Filter by user permission in organization. |
{- "organizations": [
- {
- "address": "string",
- "createDate": "2019-08-24T14:15:22Z",
- "currencyCode": "string",
- "description": "string",
- "email": "user@example.com",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "locale": "en",
- "network": {
- "creditsEmoji": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "networkRef": "b3dd1e62-e6d5-4d2c-a5f9-7859f0f69b0d",
- "timezoneId": "string",
- "title": "string"
}
]
}
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 the organization.
organizationRef required | string <uuid> The id of the organization. |
{- "membershipRequests": [
- {
- "comment": "string",
- "createDate": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
]
}
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 all memberships.
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 - |
userEmail | string <email> Filter by user's email |
{- "memberships": [
- {
- "company": {
- "id": "string",
- "title": "string"
}, - "companyRef": "string",
- "createDate": "string",
- "credits": {
- "expiring": 0,
- "permanent": 0
}, - "deleteDate": "string",
- "id": 0,
- "invitationDate": "string",
- "metadata": { },
- "notes": "string",
- "organizationRef": "string",
- "role": "member",
- "plan": {
- "addons": [
- {
- "amount": 0,
- "title": "string"
}
], - "autoInvoice": true,
- "credits": 0,
- "currentInterval": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "discounts": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "payWithInvoice": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "period": "day",
- "price": 0,
- "priceTotal": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "template": {
- "id": "string"
}, - "title": "string"
}, - "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
], - "limit": 0,
- "offset": 0,
}
Create a membership and send an email invitation to join.
required | object |
{- "membership": {
- "companyRef": "75c4824c-34ea-49c7-bc15-38b73f374457",
- "role": "admin",
- "metadata": { },
- "notes": "string",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "user": {
- "email": "user@example.com",
- "about": "string",
- "name": "string",
- "phoneNumber": "string",
- "surname": "string"
}
}
}
{- "membership": {
- "company": {
- "id": "string",
- "title": "string"
}, - "companyRef": "string",
- "createDate": "string",
- "credits": {
- "expiring": 0,
- "permanent": 0
}, - "deleteDate": "string",
- "id": 0,
- "invitationDate": "string",
- "metadata": { },
- "notes": "string",
- "organizationRef": "string",
- "role": "member",
- "plan": {
- "addons": [
- {
- "amount": 0,
- "title": "string"
}
], - "autoInvoice": true,
- "credits": 0,
- "currentInterval": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "discounts": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "payWithInvoice": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "period": "day",
- "price": 0,
- "priceTotal": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "template": {
- "id": "string"
}, - "title": "string"
}, - "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
}
Retrieve all deleted memberships.
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 - |
userEmail | string <email> Filter by user's email |
{- "memberships": [
- {
- "company": {
- "id": "string",
- "title": "string"
}, - "companyRef": "string",
- "createDate": "string",
- "credits": {
- "expiring": 0,
- "permanent": 0
}, - "deleteDate": "string",
- "id": 0,
- "invitationDate": "string",
- "metadata": { },
- "notes": "string",
- "organizationRef": "string",
- "role": "member",
- "plan": {
- "addons": [
- {
- "amount": 0,
- "title": "string"
}
], - "autoInvoice": true,
- "credits": 0,
- "currentInterval": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "discounts": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "payWithInvoice": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "period": "day",
- "price": 0,
- "priceTotal": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "template": {
- "id": "string"
}, - "title": "string"
}, - "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
], - "limit": 0,
- "offset": 0,
}
Retrieve a certain membership.
id required | integer <int64> The id of membership. |
{- "membership": {
- "company": {
- "id": "string",
- "title": "string"
}, - "companyRef": "string",
- "createDate": "string",
- "credits": {
- "expiring": 0,
- "permanent": 0
}, - "deleteDate": "string",
- "id": 0,
- "invitationDate": "string",
- "metadata": { },
- "notes": "string",
- "organizationRef": "string",
- "role": "member",
- "plan": {
- "addons": [
- {
- "amount": 0,
- "title": "string"
}
], - "autoInvoice": true,
- "credits": 0,
- "currentInterval": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "discounts": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "payWithInvoice": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "period": "day",
- "price": 0,
- "priceTotal": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "template": {
- "id": "string"
}, - "title": "string"
}, - "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
}
Update a certain membership.
id required | integer <int64> The id of the membership. |
required | object |
{- "membership": {
- "metadata": { },
- "role": "admin"
}
}
{- "membership": {
- "company": {
- "id": "string",
- "title": "string"
}, - "companyRef": "string",
- "createDate": "string",
- "credits": {
- "expiring": 0,
- "permanent": 0
}, - "deleteDate": "string",
- "id": 0,
- "invitationDate": "string",
- "metadata": { },
- "notes": "string",
- "organizationRef": "string",
- "role": "member",
- "plan": {
- "addons": [
- {
- "amount": 0,
- "title": "string"
}
], - "autoInvoice": true,
- "credits": 0,
- "currentInterval": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "discounts": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "payWithInvoice": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "period": "day",
- "price": 0,
- "priceTotal": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "template": {
- "id": "string"
}, - "title": "string"
}, - "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
}
Create a subscription to a certain membership.
id required | number The id of the membership. |
required | object |
{- "plan": {
- "addons": [
- {
- "amount": 0,
- "title": "string"
}
], - "autoInvoice": true,
- "credits": 0,
- "discounts": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "payWithInvoice": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "period": "day",
- "price": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "template": {
- "id": "string"
}, - "title": "string"
}
}
{- "membership": {
- "company": {
- "id": "string",
- "title": "string"
}, - "companyRef": "string",
- "createDate": "string",
- "credits": {
- "expiring": 0,
- "permanent": 0
}, - "deleteDate": "string",
- "id": 0,
- "invitationDate": "string",
- "metadata": { },
- "notes": "string",
- "organizationRef": "string",
- "role": "member",
- "plan": {
- "addons": [
- {
- "amount": 0,
- "title": "string"
}
], - "autoInvoice": true,
- "credits": 0,
- "currentInterval": {
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z"
}, - "discounts": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "payWithInvoice": {
- "credits": 0,
- "desks": 0,
- "events": 0,
- "rooms": 0,
- "shop": 0
}, - "period": "day",
- "price": 0,
- "priceTotal": 0,
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "template": {
- "id": "string"
}, - "title": "string"
}, - "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
}
Spacebring allows users to join multiple locations. The "Network" resource represents a network of locations that a user is a member of.
Retrieve all registrations in network.
networkRef required | string <uuid> The id of the network |
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 |
{- "registrations": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "privacyConsentDate": "2019-08-24T14:15:22Z",
- "termsConsentDate": "2019-08-24T14:15:22Z",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}
}
], - "limit": 0,
- "offset": 0,
}
Spacebring allows users to buy products in shop. The "Order" resource represents an actual order for a certain product in shop.
Retrieve all orders.
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 - |
{- "orders": [
- {
- "comment": null,
- "createDate": "2019-08-24T14:15:22Z",
- "product": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "title": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "quantity": 0,
- "productOption": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "productOptionRef": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
], - "limit": 0,
- "offset": 0,
- "total": 0,
}
Spacebring allows users to buy products in shop. The "Products" resource represents an actual product in a certain location.
organizationRef required | string <uuid> The id of the location. |
{- "products": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "isFeatured": true,
- "options": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "customTaxEnabled": true,
- "isCreditsEnabled": true,
- "isMoneyEnabled": true,
- "customTaxRate": 0,
- "price": {
- "currency": "string",
- "money": 0,
- "credits": 0
}
}
], - "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "productCategoryRef": "4100c3ea-7846-49a0-a4b3-9256c5196ba8",
- "title": "string"
}
]
}
Update a certain product.
id required | string <uuid> The id of the product. |
required | object |
{- "product": {
- "description": "string",
- "productCategoryRef": "4100c3ea-7846-49a0-a4b3-9256c5196ba8",
- "isFeatured": true,
- "options": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "customTaxEnabled": true,
- "customTaxRate": 0,
- "isAvailable": true,
- "isCreditsEnabled": true,
- "isMoneyEnabled": true,
- "priceCredits": 0,
- "priceMoney": 0
}
]
}
}
{- "product": {
- "createDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "isFeatured": true,
- "options": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "description": "string",
- "customTaxEnabled": true,
- "isCreditsEnabled": true,
- "isMoneyEnabled": true,
- "customTaxRate": 0,
- "price": {
- "currency": "string",
- "money": 0,
- "credits": 0
}
}
], - "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "productCategoryRef": "4100c3ea-7846-49a0-a4b3-9256c5196ba8",
- "title": "string"
}
}
Spacebring allows users to book meeting rooms. The "Room Booking" resource represents a booking of a room in a certain location.
Retrieve all room bookings for a certain room.
roomRef | string <uuid> The id of the room. Required if |
organizationRef | string <uuid> The id of the organization. Required if |
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 - |
{- "roomBooking": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "memo": "string",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "room": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "roomRef": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
], - "limit": 0,
- "offset": 0,
- "total": 0,
}
Create a room booking in a certain room.
required | object |
{- "roomBooking": {
- "endDate": "2019-08-24T14:15:22Z",
- "memo": "string",
- "roomRef": "5293b846-634b-43b8-b014-8a42d0f6d0e6",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string",
- "userRef": "string"
}
}
{- "roomBooking": {
- "createDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "memo": "string",
- "payment": {
- "type": "bill",
- "billItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "billRef": "string"
}, - "transactionItem": {
- "amount": 0,
- "amountType": "credits",
- "currency": "string",
- "grossAmount": 0,
- "id": "string",
- "tax": {
- "amount": 0,
- "inclusive": true,
- "rate": 0
}, - "transactionRef": "string"
}
}, - "room": {
- "title": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1"
}, - "roomRef": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string",
- "user": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRef": "string"
}
}
Spacebring allows users to book meeting rooms. The "Room" resource represents an actual meeting room in a certain location.
Retrieve rooms in the organization.
organizationRef required | string <uuid> The id of the organization. |
startDate | string <date-time> Deprecated Get rooms available for booking. Required if |
endDate | string <date-time> Deprecated Get rooms available for booking. Required if |
{- "rooms": [
- {
- "access": {
- "companies": [
- "string"
], - "isLimited": true,
- "visibility": "admins"
}, - "createDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "seats": 0,
- "title": "string",
- "price": {
- "credits": 0,
- "currency": "string",
- "money": 0
}
}
]
}
Spacebring allows users to report issues to administrators. The "Ticket" resource represents a support ticket in a certain location.
Retrieve all tickets.
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 - |
{- "limit": 0,
- "offset": 0,
- "total": 0,
- "tickets": [
- {
- "createDate": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number": 0,
- "organizationRef": "string",
- "status": "new",
- "type": "access",
- "updateDate": "2019-08-24T14:15:22Z",
- "userAssignee": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRequester": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRefAssignee": "string",
- "userRefRequester": "string"
}
]
}
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.
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 |
{- "transactions": [
- {
- "amount": 0,
- "createDate": "2019-08-24T14:15:22Z",
- "currencyCode": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "string",
- "type": "string",
- "company": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "deskBooking": {
- "date": "2019-08-24",
- "deleteDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "desk": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "organization": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}
}
}, - "eventPass": {
- "deleteDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "event": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "title": "string",
- "organization": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}
}
}, - "invoice": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "order": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "quantity": 0,
- "product": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}, - "productOption": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}
}, - "payment": {
- "approved": true,
- "status": "string",
- "type": "string"
}, - "refund": {
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}, - "roomBooking": {
- "deleteDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "startDate": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "room": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string",
- "organization": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "title": "string"
}
}
}, - "user": {
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "surname": "string"
}
}
], - "links": {
- "next": "string"
}
}
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.
Retrieve user by email.
email required | string The email of user to search. |
{- "users": [
- {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}
]
}
Spacebring allows members to register visitors. The "Visit" resource represents a preliminary registration of a visit in a certain location.
Create a visit.
required | object |
{- "visit": {
- "comment": "string",
- "date": "2019-08-24T14:15:22Z",
- "organizationRef": "da2fa94b-07ee-4da1-9af4-d6710e84c8e1",
- "visitor": {
- "email": "string",
- "name": "string",
- "phoneNumber": "string",
- "surname": "string"
}
}
}
{- "visit": {
- "code": "102288",
- "comment": "string",
- "checkInDate": "2019-08-24T14:15:22Z",
- "checkOutDate": "2019-08-24T14:15:22Z",
- "createDate": "2019-08-24T14:15:22Z",
- "date": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "organizationRef": "string",
- "userHost": {
- "about": "string",
- "email": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "phoneNumber": "string",
- "photoUrl": "string",
- "surname": "string"
}, - "userRefHost": "string",
- "visitor": {
- "email": "string",
- "name": "string",
- "phoneNumber": "string",
- "surname": "string"
}
}
}