Skip to main content
API docs by Redocly

Bookla Platform API (1.0)

Download OpenAPI specification:Download

API Support: support@bookla.com URL: https://bookla.com/support Terms of Service

This is the API documentation for the Bookla Platform API.

OpenAPI

Company

The "Company" serves as the foundational element within the Bookla system. It acts as the central entity to which services and resources are linked. Companies can encapsulate legal information, crucial for invoicing purposes, especially when integrating payment functionalities.

A company in the Bookla platform is not just a business entity; it's the primary instance around which the booking infrastructure revolves. Merchants can manage multiple companies under a single account, seamlessly switching between them as needed to cater to diverse operational requirements.

List companies

Method to get list of companies for merchant

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create company

Method to create a company for merchant

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Company data

name
required
string

Name of the company

timeZone
required
string

Time zone of the company

Responses

Request samples

Content type
application/json
{
  • "name": "Company Name",
  • "timeZone": "America/New_York"
}

Response samples

Content type
application/json
{
  • "createdAt": "2021-01-01T12:00:00Z",
  • "enabled": true,
  • "id": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "name": "string",
  • "timeZone": "America/New_York",
  • "updatedAt": "2021-01-01T12:00:00Z"
}

Delete company

Method to delete company for merchant

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

Responses

Get company

Method to get company for merchant

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2021-01-01T12:00:00Z",
  • "enabled": true,
  • "id": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "name": "string",
  • "timeZone": "America/New_York",
  • "updatedAt": "2021-01-01T12:00:00Z"
}

Service

Service - is a service that is provided by the company. Service is linked to one or many resources. These are services that are provided by the location (company).

Types of services:
1. Fixed - Services with a predetermined duration (e.g., 1-hour massage, 1-hour training session)
2. Flexible - Services where clients can choose the duration of the booking (e.g., tennis court, wakeboard reservation).
3. Group - Services that accommodate multiple bookings within a single time slot until the capacity is reached (e.g., group training, group excursions).
4. Ticket - Similar to group services but requires selecting tickets for the slot (e.g., concert tickets, museum entry).
5. Days - Services intended for long-term bookings (e.g., guest houses, hotel stays).
6. Sharable - Pay-as-you-go bookings (e.g., scooter rental, car rental, equipment rental).

List services

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

Request Body schema: application/json
required

Service data

color
string

Color of the service. Can be used to differentiate services in the UI. Must be a valid hex color code.

object

Metadata of the service

name
required
string

Name of the service

object

Service settings

type
required
string

Type of the service. Can be one of fixed, flexible, group, ticket, days

Responses

Request samples

Content type
application/json
{
  • "color": "#FF0000",
  • "metaData": {
    },
  • "name": "Service name",
  • "settings": {
    },
  • "type": "fixed"
}

Response samples

Content type
application/json
{
  • "color": "#FF0000",
  • "companyID": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "createdAt": "2021-01-01T12:00:00Z",
  • "disabledAt": "2021-01-01T12:00:00Z",
  • "id": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "metaData": {
    },
  • "name": "Service name",
  • "settings": {
    },
  • "type": "fixed",
  • "updatedAt": "2021-01-01T12:00:00Z"
}

Delete service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Responses

Get one service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Responses

Response samples

Content type
application/json
{
  • "color": "#FF0000",
  • "companyID": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "createdAt": "2021-01-01T12:00:00Z",
  • "disabledAt": "2021-01-01T12:00:00Z",
  • "id": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "metaData": {
    },
  • "name": "Service name",
  • "settings": {
    },
  • "type": "fixed",
  • "updatedAt": "2021-01-01T12:00:00Z"
}

Update service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Request Body schema: application/json
required

Update service data

color
string

Color of the service. Can be used to differentiate services in the UI. Must be a valid hex color code.

enabled
boolean

Flag to enable or disable the service

object

Metadata update object

name
string

Name of the service

Responses

Request samples

Content type
application/json
{
  • "color": "#FF0000",
  • "enabled": true,
  • "metaDataUpdate": {
    },
  • "name": "Service name"
}

Update service settings

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Request Body schema: application/json
required

Service data

bookingPolicy
string

Booking policy of the service. Can be one of confirmation, instant, prepayment, deposit

bufferAfter
string

Buffer time after booking. Must be a valid ISO 8601 duration, e.g. PT1H for 1 hour.

bufferBefore
string

Buffer time before booking. Must be a valid ISO 8601 duration, e.g. PT1H for 1 hour.

currency
string

Currency of the service. Must be a valid ISO 4217 currency code.

duration
string

Duration of the service. Must be a valid ISO 8601 duration, e.g. PT1H for 1 hour.

object

Tax settings of the service. Can be used to calculate taxes for the service price.

timeInterval
string

Time interval when service can be booked. Must be a valid ISO 8601 duration, e.g. PT30M for 30 min.

Responses

Request samples

Content type
application/json
{
  • "bookingPolicy": "instant",
  • "bufferAfter": "PT1H",
  • "bufferBefore": "PT1H",
  • "currency": "USD",
  • "duration": "PT1H",
  • "tax": {
    },
  • "timeInterval": "PT1H"
}

Resource

A Resource refers to any entity a company offers that clients can book, including human resources like hairdressers or coaches, and physical assets such as tennis courts or guest houses. Resources are central to scheduling appointments in the Bookla ecosystem.

List resources

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a resource

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

Request Body schema: application/json
required

Resource data

color
string

Color of the resource. Can be used to differentiate resources in the UI. Must be a valid hex color code.

object

Metadata of the resource

name
required
string

Name of the resource

Responses

Request samples

Content type
application/json
{
  • "color": "#FF0000",
  • "metaData": {
    },
  • "name": "Resource Name"
}

Response samples

Content type
application/json
{
  • "color": "#FF0000",
  • "companyID": "31517972-ccad-406c-9100-c0c49e37cf37",
  • "createdAt": "2024-01-01T08:00:00Z",
  • "disabledAt": "2024-01-01T08:00:00Z",
  • "id": "b431830e-8ee8-4755-bb0c-cd67f855b8f9",
  • "metaData": {
    },
  • "name": "Resource Name",
  • "updatedAt": "2024-01-01T08:00:00Z"
}

Delete resource

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Resource ID

Responses

Get one resource

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

resource_id
required
string <uuid>

Resource ID

Responses

Response samples

Content type
application/json
{
  • "color": "#FF0000",
  • "companyID": "31517972-ccad-406c-9100-c0c49e37cf37",
  • "createdAt": "2024-01-01T08:00:00Z",
  • "disabledAt": "2024-01-01T08:00:00Z",
  • "id": "b431830e-8ee8-4755-bb0c-cd67f855b8f9",
  • "metaData": {
    },
  • "name": "Resource Name",
  • "updatedAt": "2024-01-01T08:00:00Z"
}

Update resource

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

resource_id
required
string <uuid>

Resource ID

Request Body schema: application/json
required

Resource data

color
string

Color of the resource. Can be used to differentiate resources in the UI. Must be a valid hex color code.

enabled
boolean

Whether the resource is enabled or not. If not provided, the resource will be enabled.

object

Metadata update object

name
string

Name of the resource

Responses

Request samples

Content type
application/json
{
  • "color": "#FF0000",
  • "enabled": true,
  • "metaDataUpdate": {
    },
  • "name": "Resource Name"
}

Response samples

Content type
application/json
{
  • "color": "#FF0000",
  • "companyID": "31517972-ccad-406c-9100-c0c49e37cf37",
  • "createdAt": "2024-01-01T08:00:00Z",
  • "disabledAt": "2024-01-01T08:00:00Z",
  • "id": "b431830e-8ee8-4755-bb0c-cd67f855b8f9",
  • "metaData": {
    },
  • "name": "Resource Name",
  • "updatedAt": "2024-01-01T08:00:00Z"
}

Capacity

The "Capacity" rule defines the maximum number of clients or tickets that can be accommodated within a given time slot. This rule is particularly useful for group and ticket services, where multiple clients can book the same slot until the capacity is reached.

List capacity rules

path Parameters
company_id
required
string

Company ID

service_id
required
string

Service ID

query Parameters
type
string

Type of the rule. Can be one of capacity, ticket_capacity

Responses

Response samples

Content type
application/json
{
  • "capacities": [
    ],
  • "resources": [
    ],
  • "tickets": [
    ]
}

Create a capacity

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

service_id
required
string

Service ID

Request Body schema: application/json
required

Capacity rule data

object

Limitation of the rule.

priority
integer

Priority of the rule. Rules with higher priority will be applied first.

spots
integer

The number of spots available.

object

A key-value pair of ticket ID and the number of spots available per ticket. Required only for ticket services.

type
string

Type of the rule. Can be one of capacity, ticket_capacity

Responses

Request samples

Content type
application/json
{
  • "limitation": {
    },
  • "priority": 0,
  • "spots": 10,
  • "spotsPerTicket": {
    },
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "2021-01-01T12:00:00Z",
  • "id": "string",
  • "limitation": {
    },
  • "priority": 0,
  • "serviceID": "string",
  • "spots": 10,
  • "spotsPerTicket": {
    },
  • "type": "string"
}

Delete a capacity

path Parameters
company_id
required
string

Company ID

service_id
required
string

Service ID

rule_id
required
string

Rule ID

Responses

ClosingPeriod

Closing periods are used to define when a resource is not available. This is particularly useful for holidays or other special occasions.

List closing periods

path Parameters
company_id
required
string

Company ID

resource_id
required
string

Resource ID

Responses

Create a closing period

path Parameters
company_id
required
string

Company ID

resource_id
required
string

Resource ID

Request Body schema: application/json
required

Closing period data

endTime
string

End date and time of the rule.

priority
integer

Priority of the rule. Rules with higher priority will be applied first.

startTime
string

Start date and time of the rule.

Responses

Request samples

Content type
application/json
{
  • "endTime": "string",
  • "priority": 0,
  • "startTime": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "endTime": "string",
  • "id": "string",
  • "priority": 0,
  • "resourceID": "string",
  • "startTime": "string",
  • "updatedAt": "string"
}

Delete a closing period

path Parameters
company_id
required
string

Company ID

resource_id
required
string

Resource ID

rule_id
required
string

Rule ID

Responses

Discount

The "Discount" rule allows merchants to offer discounts based on various parameters, such as the number of bookings, the time of booking, or the duration of the booking. This rule is highly versatile, enabling merchants to create custom discount strategies to attract and retain clients.

List discounts for service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

query Parameters
type
string

Discount type

Responses

Response samples

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

Create a discount

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Request Body schema: application/json
required

Discount data

object

Limitation of the discount

priority
required
integer

Priority of the discount

Array of objects (github_com_bookla-app_platform_api_platform_pricing_direct.TicketVolumeDiscountRule)

A list of ticket volume discount rules

sumsUp
boolean

If true, the discount is summed up with other discounts

type
required
string

Type of the discount. Can be one of volume, ticket_volume

Responses

Request samples

Content type
application/json
{
  • "limitation": {
    },
  • "priority": 0,
  • "rules": [
    ],
  • "sumsUp": true,
  • "type": "ticket"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "limitation": {
    },
  • "priority": 0,
  • "rules": [
    ],
  • "serviceID": "string",
  • "sumsUp": true,
  • "type": "string"
}

Delete a discount for service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

discount_id
required
string <uuid>

Discount ID

Responses

Pricing

This rule dynamically determines the pricing of each service offered. It is highly versatile, allowing adjustments based on various parameters to meet any pricing strategy needs.

List price rules for a service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "rules": [
    ],
  • "tickets": [
    ]
}

Create a price rule for service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Request Body schema: application/json
required

Price rule data

duration
string

Duration of the price rule, e.g. PT1H. Required for fixed, flexible and days price rules

object

Limitation of the price rule

maxDuration
string

Maximum duration of the price rule, e.g. PT4H. Used for flexible and days price rules

minDuration
string

Minimum duration of the price rule, e.g. PT1H. Used for flexible and days price rules

required
object

Price of the price rule

priority
required
integer

Priority of the price rule

ticketID
string

A unique identifier of the ticket

type
required
string

Type of the price rule. Can be one of fixed, flexible, group, ticket, days

Responses

Request samples

Content type
application/json
{
  • "duration": "PT1H",
  • "limitation": {
    },
  • "maxDuration": "PT4H",
  • "minDuration": "PT1H",
  • "price": {
    },
  • "priority": 1,
  • "ticketID": "90bc7809-b277-4ddf-a827-5c9fdb9a81ad",
  • "type": "fixed"
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "duration": "string",
  • "id": "string",
  • "limitation": {
    },
  • "maxDuration": "string",
  • "minDuration": "string",
  • "price": {
    },
  • "priority": 0,
  • "serviceID": "string",
  • "ticketID": "string",
  • "type": "string"
}

Delete price rule for particular service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

price_rule_id
required
string <uuid>

Price rule ID

Responses

List of service-resource links

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Responses

Response samples

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

Link service with resource

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Request Body schema: application/json
required

Link data

relatedResourceIDs
Array of strings

IDs of the resources that are related to the linked resource. When the linked resource is booked, the related resources are also booked.

resourceID
string

ID of the resource that is linked to the service

Responses

Request samples

Content type
application/json
{
  • "relatedResourceIDs": [
    ],
  • "resourceID": "90bc7809-b277-4ddf-a827-5c9fdb9a81ad"
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "relatedResourceIDs": [
    ],
  • "resourceID": "string",
  • "serviceID": "string",
  • "updatedAt": "string"
}

Slot

The "Slot" entity represents a group or ticket service's time slot. It encapsulates the start and end times of the slot, as well as the number of available slots.

List slots for a service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create slot for service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Request Body schema: application/json
required

Slot data

duration
string

In ISO8601 format

object

Recurring rule

startTime
required
string

Start time of the slot in RFC3339 format

Responses

Request samples

Content type
application/json
{
  • "duration": "PT1H",
  • "repeat": {
    },
  • "startTime": "2021-01-01T12:00:00Z"
}

Response samples

Content type
application/json
{
  • "createdAt": "2021-01-01T12:00:00Z",
  • "duration": "PT1H",
  • "id": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "resourceID": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "rrule": "FREQ=WEEKLY;BYDAY=MO,WE,FR",
  • "serviceID": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "startTime": "2021-01-01T12:00:00Z",
  • "type": "string",
  • "updatedAt": "2021-01-01T12:00:00Z"
}

Delete slot for particular service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

slot_id
required
string

Slot ID

Responses

Ticket

The "Ticket" entity represents a ticket that can be booked by a client.

List tickets for a service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create ticket for service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Request Body schema: application/json
required

Ticket data

object (service.CreateTicketRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "createdAt": "2021-01-01T12:00:00Z",
  • "enabled": true,
  • "id": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "metaData": {
    },
  • "name": "Ticket name",
  • "serviceID": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "updatedAt": "2021-01-01T12:00:00Z"
}

Delete ticket for particular service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

ticket_id
required
string

Ticket ID

Responses

Get a ticket for a service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

ticket_id
required
string

Ticket ID

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2021-01-01T12:00:00Z",
  • "enabled": true,
  • "id": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "metaData": {
    },
  • "name": "Ticket name",
  • "serviceID": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "updatedAt": "2021-01-01T12:00:00Z"
}

Times

Get available times for services.

List available times

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

service_id
required
string <uuid>

Service ID

Request Body schema: application/json
required

Times data

duration
string

Duration of the timeslot in ISO8601 format (eg. PT1H)

from
required
string

Start of the time range in RFC3339 format

resourceIDs
Array of strings

IDs of the resources that will be used to filter available timeslots

spots
integer

Number of spots that will be requested. Required for group services

object

A key-value pair of ticket IDs and the number of spots that will be requested. Required for ticket services

to
required
string

End of the time range in RFC3339 format

Responses

Request samples

Content type
application/json
{
  • "duration": "PT1H",
  • "from": "2021-01-01T00:00:00Z",
  • "resourceIDs": [
    ],
  • "spots": 2,
  • "tickets": {
    },
  • "to": "2021-01-01T23:59:59Z"
}

Response samples

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

WorkingHours

Defines the availability of resources, ensuring bookings align with operational hours.

Delete working hours for resource

Authorizations:
ApiKeyAuth
path Parameters
resource_id
required
string <uuid>

Resource ID

company_id
required
string <uuid>

Company ID

Request Body schema: application/json
required

Working hours data

object (direct.DeleteWorkingHoursRequest)

Responses

Request samples

Content type
application/json
{ }

List working hours

Authorizations:
ApiKeyAuth
path Parameters
resource_id
required
string <uuid>

Resource ID

company_id
required
string <uuid>

Company ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create working hours

Authorizations:
ApiKeyAuth
path Parameters
resource_id
required
string <uuid>

Resource ID

company_id
required
string <uuid>

Company ID

Request Body schema: application/json
required

Working hours data

endTime
string

End date and time of the rule.

priority
integer

Priority of the rule. Rules with higher priority will be applied first.

startTime
string

Start date and time of the rule.

Array of objects (direct.WorkingHour)

The list of working hours for the resource.

Responses

Request samples

Content type
application/json
{
  • "endTime": "string",
  • "priority": 0,
  • "startTime": "string",
  • "workingHours": [
    ]
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "endTime": "string",
  • "id": "string",
  • "priority": 0,
  • "resourceID": "string",
  • "startTime": "string",
  • "updatedAt": "string",
  • "workingHours": [
    ]
}

Booking

Delete booking

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

booking_id
required
string <uuid>

Booking ID

Responses

Get bookings

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

query Parameters
from
string

From date and time in RFC3339 format.

limit
integer

Limit the number of results. Default is 100.

offset
integer

Offset the results. Default is 0.

resourceIDs
string

List of resource IDs to filter by seperated by comma.

serviceIDs
string

List of service IDs to filter by seperated by comma.

to
string

To date and time in RFC3339 format.

Responses

Response samples

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

Create a booking

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

Request Body schema: application/json
required

Booking data

clientID
string <uuid>

Identifier of the client this booking is associated with. Can be blank if the client is not known.

duration
string

In ISO8601 format

ignoreSchedule
boolean
object

Set of key-value pairs that you can attach to an object.

object

Recurring rule

resourceID
required
string <uuid>

Identifier for the resource this booking is associated with.

serviceID
required
string <uuid>

Identifier for the service this booking is associated with.

spots
integer

Number of spots booked. It's greater than 1 for services with type group and ticket

startTime
required
string

Start time of the booking in RFC3339 format.

object

A set of key-value pair pairs where key is the ticket ID and value is the number of tickets booked. Required for services with type ticket

Responses

Request samples

Content type
application/json
{
  • "clientID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "duration": "PT1H",
  • "ignoreSchedule": true,
  • "metaData": {
    },
  • "repeat": {
    },
  • "resourceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "serviceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "spots": 2,
  • "startTime": "2021-01-01T12:00:00Z",
  • "tickets": {
    }
}

Response samples

Content type
application/json
{
  • "bookingPolicy": "instant",
  • "clientID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "clientInitiated": true,
  • "createdAt": "2021-01-01T12:00:00Z",
  • "currency": "USD",
  • "duration": "PT1H",
  • "endTime": "2021-01-01T13:00:00Z",
  • "id": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "metaData": {
    },
  • "paymentURL": "string",
  • "price": 1000,
  • "recurringID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "resourceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "rrule": "FREQ=WEEKLY;BYDAY=MO,WE,FR",
  • "serviceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "spots": 2,
  • "startTime": "2021-01-01T12:00:00Z",
  • "status": "confirmed",
  • "tickets": {
    },
  • "type": "fixed",
  • "updatedAt": "2021-01-01T12:00:00Z"
}

Get one booking

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

booking_id
required
string <uuid>

Booking ID

Responses

Response samples

Content type
application/json
{
  • "bookingPolicy": "instant",
  • "clientID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "clientInitiated": true,
  • "createdAt": "2021-01-01T12:00:00Z",
  • "currency": "USD",
  • "duration": "PT1H",
  • "endTime": "2021-01-01T13:00:00Z",
  • "id": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "metaData": {
    },
  • "paymentURL": "string",
  • "price": 1000,
  • "recurringID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "resourceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "rrule": "FREQ=WEEKLY;BYDAY=MO,WE,FR",
  • "serviceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "spots": 2,
  • "startTime": "2021-01-01T12:00:00Z",
  • "status": "confirmed",
  • "tickets": {
    },
  • "type": "fixed",
  • "updatedAt": "2021-01-01T12:00:00Z"
}

Update booking

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

booking_id
required
string <uuid>

Booking ID

Request Body schema: application/json
required

Update booking data

duration
string
object

Metadata update object

price
integer
resourceID
string <uuid>
spots
integer
startTime
string
status
string

Responses

Request samples

Content type
application/json
{
  • "duration": "PT1H",
  • "metaDataUpdate": {
    },
  • "price": 1000,
  • "resourceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "spots": 2,
  • "startTime": "2021-01-01T12:00:00Z",
  • "status": "confirmed"
}

Response samples

Content type
application/json
{
  • "bookingPolicy": "instant",
  • "clientID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "clientInitiated": true,
  • "createdAt": "2021-01-01T12:00:00Z",
  • "currency": "USD",
  • "duration": "PT1H",
  • "endTime": "2021-01-01T13:00:00Z",
  • "id": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "metaData": {
    },
  • "paymentURL": "string",
  • "price": 1000,
  • "recurringID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "resourceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "rrule": "FREQ=WEEKLY;BYDAY=MO,WE,FR",
  • "serviceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "spots": 2,
  • "startTime": "2021-01-01T12:00:00Z",
  • "status": "confirmed",
  • "tickets": {
    },
  • "type": "fixed",
  • "updatedAt": "2021-01-01T12:00:00Z"
}

Move a booking

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string <uuid>

Company ID

booking_id
required
string <uuid>

Booking ID

Request Body schema: application/json
required

Move booking data

ignoreSchedule
boolean
recalculatePrice
boolean
recurringUpdateStrategy
string

comment single or upcoming

resourceID
required
string <uuid>
startTime
required
string

Responses

Request samples

Content type
application/json
{
  • "ignoreSchedule": true,
  • "recalculatePrice": true,
  • "recurringUpdateStrategy": "single",
  • "resourceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "startTime": "string"
}

Response samples

Content type
application/json
{
  • "bookingPolicy": "instant",
  • "clientID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "clientInitiated": true,
  • "createdAt": "2021-01-01T12:00:00Z",
  • "currency": "USD",
  • "duration": "PT1H",
  • "endTime": "2021-01-01T13:00:00Z",
  • "id": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "metaData": {
    },
  • "paymentURL": "string",
  • "price": 1000,
  • "recurringID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "resourceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "rrule": "FREQ=WEEKLY;BYDAY=MO,WE,FR",
  • "serviceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "spots": 2,
  • "startTime": "2021-01-01T12:00:00Z",
  • "status": "confirmed",
  • "tickets": {
    },
  • "type": "fixed",
  • "updatedAt": "2021-01-01T12:00:00Z"
}

Subscription

Get capacity rules for subscriptions

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

query Parameters
subscription_ids
required
string

Subscription IDs

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create capacity rule for subscriptions

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

Request Body schema: application/json
required

Create capacity rule request

endDate
string
maxCount
integer
object
priority
integer
startDate
string
subscriptionIDs
Array of strings

Responses

Request samples

Content type
application/json
{
  • "endDate": "string",
  • "maxCount": 0,
  • "metaData": {
    },
  • "priority": 0,
  • "startDate": "string",
  • "subscriptionIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "archivedAt": "string",
  • "createdAt": "string",
  • "endDate": "string",
  • "id": "string",
  • "maxCount": 0,
  • "metaData": {
    },
  • "priority": 0,
  • "startDate": "string",
  • "subscriptionIDs": [
    ],
  • "updatedAt": "string"
}

Delete capacity rule for subscriptions

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

item_id
required
string

Capacity rule ID

Responses

Response samples

Content type
application/json
{
  • "code": "error_code",
  • "message": "Error message"
}

Update capacity rule for subscriptions

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

item_id
required
string

Capacity rule ID

Request Body schema: application/json
required

Update capacity rule request

archive
boolean
endDate
string
maxCount
integer
object (metadata.Update)
priority
integer
startDate
string
subscriptionIDs
Array of strings

Responses

Request samples

Content type
application/json
{
  • "archive": true,
  • "endDate": "string",
  • "maxCount": 0,
  • "metaDataUpdate": {
    },
  • "priority": 0,
  • "startDate": "string",
  • "subscriptionIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "archivedAt": "string",
  • "createdAt": "string",
  • "endDate": "string",
  • "id": "string",
  • "maxCount": 0,
  • "metaData": {
    },
  • "priority": 0,
  • "startDate": "string",
  • "subscriptionIDs": [
    ],
  • "updatedAt": "string"
}

Get capacity availability for subscriptions

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

query Parameters
subscription_ids
required
string

Subscription IDs

Responses

Response samples

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

Delete client subscription contract

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

item_id
required
string

Subscription contract ID

Responses

Response samples

Content type
application/json
{
  • "code": "error_code",
  • "message": "Error message"
}

Update client subscription contract

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

item_id
required
string

Subscription contract ID

Request Body schema: application/json
required

Create subscription contract request

clientID
string
duration
string
object

Metadata update object

status
string
subscriptionID
string

Responses

Request samples

Content type
application/json
{
  • "clientID": "string",
  • "duration": "string",
  • "metaDataUpdate": {
    },
  • "status": "string",
  • "subscriptionID": "string"
}

Response samples

Content type
application/json
{
  • "activeFrom": "string",
  • "clientID": "string",
  • "duration": "string",
  • "id": "string",
  • "limitations": {
    },
  • "metaData": {
    },
  • "status": "string",
  • "subscriptionID": "string"
}

Search contracts in company

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

Request Body schema: application/json
required

Search contracts request

clientIDs
Array of strings
fromDate
string
limit
integer
object (metadata.Query)
offset
integer
resourceIDs
Array of strings
serviceIDs
Array of strings
status
string
subscriptionIDs
Array of strings
toDate
string

Responses

Request samples

Content type
application/json
{
  • "clientIDs": [
    ],
  • "fromDate": "string",
  • "limit": 0,
  • "metaDataQuery": {
    },
  • "offset": 0,
  • "resourceIDs": [
    ],
  • "serviceIDs": [
    ],
  • "status": "string",
  • "subscriptionIDs": [
    ],
  • "toDate": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

List of subscriptions in company

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new subscription

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

Request Body schema: application/json
required

Create subscription request

availableFrom
string
availableTo
string
duration
string
object (subscription.CreateLimitations)
object
rRule
string
renewPeriod
string
resourceIDs
Array of strings
serviceIDs
Array of strings
ticketIDs
Array of strings
title
string

Responses

Request samples

Content type
application/json
{
  • "availableFrom": "string",
  • "availableTo": "string",
  • "duration": "string",
  • "limitations": {
    },
  • "metaData": {
    },
  • "rRule": "string",
  • "renewPeriod": "string",
  • "resourceIDs": [
    ],
  • "serviceIDs": [
    ],
  • "ticketIDs": [
    ],
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "archivedAt": "string",
  • "availableFrom": "string",
  • "availableTo": "string",
  • "createdAt": "string",
  • "duration": "string",
  • "id": "string",
  • "limitations": {
    },
  • "metaData": {
    },
  • "rRule": "string",
  • "resourceIDs": [
    ],
  • "serviceIDs": [
    ],
  • "title": "string",
  • "updatedAt": "string"
}

Delete a subscription

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

subscription_id
required
string

Subscription ID

Responses

Response samples

Content type
application/json
{
  • "code": "error_code",
  • "message": "Error message"
}

Get one subscription

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

subscription_id
required
string

Subscription ID

Responses

Response samples

Content type
application/json
{
  • "archivedAt": "string",
  • "availableFrom": "string",
  • "availableTo": "string",
  • "createdAt": "string",
  • "duration": "string",
  • "id": "string",
  • "limitations": {
    },
  • "metaData": {
    },
  • "rRule": "string",
  • "resourceIDs": [
    ],
  • "serviceIDs": [
    ],
  • "title": "string",
  • "updatedAt": "string"
}

Update a subscription

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

subscription_id
required
string

Subscription ID

Request Body schema: application/json
required

Update subscription request

archive
boolean
object

Metadata update object

resourceIDs
Array of strings
serviceIDs
Array of strings
title
string

Responses

Request samples

Content type
application/json
{
  • "archive": true,
  • "metaDataUpdate": {
    },
  • "resourceIDs": [
    ],
  • "serviceIDs": [
    ],
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "archivedAt": "string",
  • "availableFrom": "string",
  • "availableTo": "string",
  • "createdAt": "string",
  • "duration": "string",
  • "id": "string",
  • "limitations": {
    },
  • "metaData": {
    },
  • "rRule": "string",
  • "resourceIDs": [
    ],
  • "serviceIDs": [
    ],
  • "title": "string",
  • "updatedAt": "string"
}

Get price rules for subscriptions

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

query Parameters
subscription_ids
required
string

Subscription IDs

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create price rule for subscriptions

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

Request Body schema: application/json
required

Create price rule request

comparedPrice
integer
endDate
string
object
price
integer
priority
integer
startDate
string
subscriptionIDs
Array of strings

Responses

Request samples

Content type
application/json
{
  • "comparedPrice": 0,
  • "endDate": "string",
  • "metaData": {
    },
  • "price": 0,
  • "priority": 0,
  • "startDate": "string",
  • "subscriptionIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "archivedAt": "string",
  • "comparedPrice": 0,
  • "createdAt": "string",
  • "endDate": "string",
  • "id": "string",
  • "metaData": {
    },
  • "price": 0,
  • "priority": 0,
  • "startDate": "string",
  • "subscriptionIDs": [
    ],
  • "updatedAt": "string"
}

Delete price rule for subscriptions

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

item_id
required
string

Price rule ID

Responses

Response samples

Content type
application/json
{
  • "code": "error_code",
  • "message": "Error message"
}

Update price rule for subscriptions

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

item_id
required
string

Price rule ID

Request Body schema: application/json
required

Update price rule request

archive
boolean
comparedPrice
integer
endDate
string
object (metadata.Update)
price
integer
priority
integer
startDate
string
subscriptionIDs
Array of strings

Responses

Request samples

Content type
application/json
{
  • "archive": true,
  • "comparedPrice": 0,
  • "endDate": "string",
  • "metaDataUpdate": {
    },
  • "price": 0,
  • "priority": 0,
  • "startDate": "string",
  • "subscriptionIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "archivedAt": "string",
  • "comparedPrice": 0,
  • "createdAt": "string",
  • "endDate": "string",
  • "id": "string",
  • "metaData": {
    },
  • "price": 0,
  • "priority": 0,
  • "startDate": "string",
  • "subscriptionIDs": [
    ],
  • "updatedAt": "string"
}

Get settings for subscriptions

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

Responses

Response samples

Content type
application/json
{
  • "cartExpiration": "string",
  • "createdAt": "string",
  • "currency": "string",
  • "id": "string",
  • "metaData": {
    },
  • "taxInclusive": true,
  • "taxRate": 0,
  • "updatedAt": "string"
}

Update settings for subscriptions

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

Request Body schema: application/json
required

Update settings request

cartExpiration
string
currency
string
taxInclusive
boolean
taxRate
number

Responses

Request samples

Content type
application/json
{
  • "cartExpiration": "string",
  • "currency": "string",
  • "taxInclusive": true,
  • "taxRate": 0
}

Response samples

Content type
application/json
{
  • "cartExpiration": "string",
  • "createdAt": "string",
  • "currency": "string",
  • "id": "string",
  • "metaData": {
    },
  • "taxInclusive": true,
  • "taxRate": 0,
  • "updatedAt": "string"
}

Developer

List all API keys

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new API key

Request Body schema: application/json
required

API key data

name
string
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "permissions": {
    }
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "key": "string",
  • "name": "string",
  • "permissions": {
    },
  • "state": "string"
}

ClientAuth

Client authorization

Request Body schema: application/json
required

Client login request

companyID
required
string <uuid>

CompanyID is the unique identifier of the company that you have created in the platform.

email
required
string

Email is the email address of the user. It can be used to send notifications, invoices and other information.

externalUserID
required
string

ExternalUserID is the unique identifier of the user in your system. If you don't have a unique identifier, you can use the email address or generate it.

firstName
string
lastName
string
phone
string

Responses

Request samples

Content type
application/json
{
  • "companyID": "da70841f-5a52-45eb-a31f-22e276c64625",
  • "email": "user@company.com",
  • "externalUserID": "ID123456789",
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "expiresIn": 0,
  • "refreshToken": "string"
}

Client refresh token

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "expiresIn": 0,
  • "refreshToken": "string"
}

ClientService

Endpoints to be used be client's services

Get list of services

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get one service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

service_id
required
string

Service ID

Responses

Response samples

Content type
application/json
{
  • "color": "#000000",
  • "companyID": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "createdAt": "2021-07-01T00:00:00Z",
  • "id": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "name": "Service name",
  • "resources": [
    ],
  • "type": "fixed",
  • "updatedAt": "2021-07-01T00:00:00Z"
}

Get available times for service

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

service_id
required
string

Service ID

Request Body schema: application/json
required

Times data

duration
string

In ISO8601 format, e.g. PT1H for 1 hour. Required for services with type 'flexible' and 'days'

from
string

Date and time for the beginning of the time range in RFC3339 format.

resourceIDs
Array of strings

List of resource IDs this service is associated with. Can be blank to search all resources.

spots
integer

Number of spots booked. It's greater than 1 for services with type group and ticket

object

Set of key-value pairs where key is the ticket ID and value is the number of tickets booked. Required for services with type ticket

to
string

Date and time for the end of the time range in RFC3339 format.

Responses

Request samples

Content type
application/json
{
  • "duration": "PT1H",
  • "from": "2021-01-01T00:00:00Z",
  • "resourceIDs": [
    ],
  • "spots": 2,
  • "tickets": {
    },
  • "to": "2021-01-01T23:59:59Z"
}

Response samples

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

ClientResource

Endpoints to be used be client's resources

Get list of resources

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get one resource

Authorizations:
ApiKeyAuth
path Parameters
company_id
required
string

Company ID

resource_id
required
string

Resource ID

Responses

Response samples

Content type
application/json
{
  • "color": "#000000",
  • "companyID": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "createdAt": "2021-07-01T00:00:00Z",
  • "id": "53ebf47a-9ddc-4198-8f6d-f9ff6a909158",
  • "name": "Resource name",
  • "services": [
    ],
  • "updatedAt": "2021-07-01T00:00:00Z"
}

ClientBooking

Endpoints to be used be client's bookings

Get client bookings

Get client bookings

Authorizations:
BearerAuth
query Parameters
limit
integer

Limit

offset
integer

Offset

Responses

Response samples

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

Request booking

Authorizations:
BearerAuth
path Parameters
company_id
required
string

Company ID

Request Body schema: application/json
required

Booking request

companyID
required
string <uuid>

Identifier for the company this booking is associated with.

customPurchaseDescription
string

Optional purchase description that can be passed to payment provider. Otherwise, it will be generated automatically.

duration
string

In ISO8601 format

object

Set of key-value pairs that you can attach to an object.

object

Set of key-value pairs that can be used to send data from plugins to the booking handler.

resourceID
required
string <uuid>

Identifier for the resource this booking is associated with.

serviceID
required
string <uuid>

Identifier for the service this booking is associated with.

spots
required
integer

Number of spots booked. It's greater than 1 for services with type group and ticket

startTime
required
string

Start time of the booking in RFC3339 format.

object

Set of key-value pairs where key is the ticket ID and value is the number of tickets booked. Required for services with type ticket

Responses

Request samples

Content type
application/json
{
  • "companyID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "customPurchaseDescription": "string",
  • "duration": "PT1H",
  • "metaData": {
    },
  • "pluginData": {
    },
  • "resourceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "serviceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "spots": 2,
  • "startTime": "2021-01-01T12:00:00Z",
  • "tickets": {
    }
}

Response samples

Content type
application/json
{
  • "companyID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "createdAt": "2021-01-01T12:00:00Z",
  • "currency": "USD",
  • "duration": "PT1H",
  • "endTime": "2021-01-01T13:00:00Z",
  • "id": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "metaData": {
    },
  • "paymentURL": "string",
  • "price": 1000,
  • "resourceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "serviceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "spots": 2,
  • "startTime": "2021-01-01T12:00:00Z",
  • "status": "confirmed",
  • "tickets": {
    },
  • "type": "fixed"
}

Get client booking

Get client booking

Authorizations:
BearerAuth
path Parameters
booking_id
required
string

Booking ID

Responses

Response samples

Content type
application/json
{
  • "companyID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "createdAt": "2021-01-01T12:00:00Z",
  • "currency": "USD",
  • "duration": "PT1H",
  • "endTime": "2021-01-01T13:00:00Z",
  • "id": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "metaData": {
    },
  • "paymentURL": "string",
  • "price": 1000,
  • "resourceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "serviceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "spots": 2,
  • "startTime": "2021-01-01T12:00:00Z",
  • "status": "confirmed",
  • "tickets": {
    },
  • "type": "fixed"
}

Cancel booking

Authorizations:
BearerAuth
path Parameters
booking_id
required
string

Booking ID

Request Body schema: application/json
required

Cancel booking request

object
property name*
additional property
any

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "companyID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "createdAt": "2021-01-01T12:00:00Z",
  • "currency": "USD",
  • "duration": "PT1H",
  • "endTime": "2021-01-01T13:00:00Z",
  • "id": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "metaData": {
    },
  • "paymentURL": "string",
  • "price": 1000,
  • "resourceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "serviceID": "95cd2c0c-9541-4c48-acd3-645f81f6f20e",
  • "spots": 2,
  • "startTime": "2021-01-01T12:00:00Z",
  • "status": "confirmed",
  • "tickets": {
    },
  • "type": "fixed"
}

ClientSubscription

Get client subscriptions cart in company

Authorizations:
BearerAuth
path Parameters
companyID
required
string

Company ID

Responses

Response samples

Content type
application/json
{
  • "expiresAt": "string",
  • "items": [
    ]
}

Add item to client subscriptions cart in company

Authorizations:
BearerAuth
path Parameters
companyID
required
string

Company ID

Request Body schema: application/json
required

Request body

Array of objects (subscription.ClientRequestItem)
Array
subscriptionID
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "expiresAt": "string",
  • "items": [
    ]
}

Delete item from client subscriptions cart in company

Authorizations:
BearerAuth
path Parameters
companyID
required
string

Company ID

item_id
required
string

Item ID

Responses

Response samples

Content type
application/json
{
  • "expiresAt": "string",
  • "items": [
    ]
}

Checkout client subscriptions cart in company

Authorizations:
BearerAuth
path Parameters
companyID
required
string

Company ID

Responses

Response samples

Content type
application/json
{
  • "currency": "string",
  • "expiresAt": "string",
  • "items": [
    ],
  • "paymentURL": "string",
  • "price": 0,
  • "tax": 0,
  • "taxInclusive": true,
  • "taxRate": 0
}

Get list of purchased subscriptions for client in company

Authorizations:
BearerAuth
path Parameters
companyID
required
string

Company ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get one purchased subscription for client in company

Authorizations:
BearerAuth
path Parameters
companyID
required
string

Company ID

itemID
required
string

Item ID

Responses

Response samples

Content type
application/json
{
  • "activeFrom": "string",
  • "clientID": "string",
  • "duration": "string",
  • "id": "string",
  • "limitations": {
    },
  • "metaData": {
    },
  • "status": "string",
  • "subscriptionID": "string"
}

Renew purchased subscriptions for client in company

Authorizations:
BearerAuth
path Parameters
companyID
required
string

Company ID

Request Body schema: application/json
required

Request body

ids
Array of strings

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "currency": "string",
  • "expiresAt": "string",
  • "items": [
    ],
  • "paymentURL": "string",
  • "price": 0,
  • "tax": 0,
  • "taxInclusive": true,
  • "taxRate": 0
}

Get list of available subscriptions for client in company

Authorizations:
ApiKeyAuth
path Parameters
companyID
required
string

Company ID

query Parameters
ids
Array of strings

Subscription IDs

Responses

Response samples

Content type
application/json
[
  • {
    }
]