Skip to content
Developers
Integrations
Docs
Support
Search
Ctrl
K
Cancel
Welcome!
Getting started
Authentication
Guides
Organizations
Overview
Company
Location
Article Management
Overview
Webhooks
Securing Webhooks
Overview
Booking Widget
Booking: Quick Start
Booking: Advanced Modal Usage
Booking: Attributes Reference
Booking: Event Tracking
Reference
Organizations API
Overview
Company
/v1/companies
/v1/companies/{id}
Location
/v1/companies/{id}/locations
Article Management API
Overview
Article
Batch Create Articles
Batch Update Articles
Get Articles
Get Article By ID
Category
Batch Create Categories
Batch Update Categories
Get Categories
Get Category By ID
Webhooks
Accounting
Organization
POS
PRIM
Classic APIs
Guides
Booking API
Booking API: Overview
Booking API: Creating a Personal Access Token (PAT)
Booking API: How to use
Booking API: Article Group Type
Booking API: Statuses
Booking API: Test methods
Forecast Import API
Forecast Import API: Overview
Import API
Import API: Overview
Import API: Data Specification
Import API: JSON Schema
Import API: Payload Example
Import API: XML Schema
Raw Material API
Raw Material API: Overview
Report API
Report API: Getting Started
Report API: Setting up the API
Export API
Export API: Overview
Export API: Data Specification
Webhooks
Webhooks: Overview
Webhooks: Creating Webhooks
Webhooks: Securing Your Webhooks
Webhooks: Triggering Employee Webhooks
Webhooks: Payload Examples (Classic)
Webhooks: Payload Examples (Snapshot)
Reference
Booking API
Overview
Webhooks
Lists all configured webhooks
All currently available events that can be subscribed to
Use the names of the events when creating or updating a webhook. Make sure the endpoint is publicly accessible
Use the names of the events when creating or updating a webhook. Make sure the endpoint is publicly accessible
Delete webhook by id
Webhooks_GenerateSecret
Webhooks_HasSecret
Booking - External settings
Returns ExternalBookingSettings fo a Unit
Returns logo fo a Unit
Booking - WebBooking
Get a list of all times that may be bookable via the web.
Get a cached list of all times that may be bookable via the web for a list of systems.
List web bookings.
Updates a web booking.
Create new web booking.
Find web booking by GUID.
Updates a web booking.
Create and return the payment terminal url for a booking
Create and return the payment terminal url for a booking
Finalizes a pending web booking
Refreshes a pending web booking, so that it is not purged automatically
Cancels a web booking
Accepts a WaitList offer on a web booking
Respond to an inquiry proposal for a web booking
Get article stock for the given IDs
Get customerContact connection by id
Gets states for all dates in the given interval
Get only payment information on a given web booking.
Updates payment information on a given web booking.
All - Tests
Test authenticated access
Test unauthenticated access
Simple test.
Version_GetVersion
Surveys
List all recipients
Get specified recipient
Get specified recipient and survey content
Answer specific survey
Send survey to recipient
Send reminder to recipient
Cancel the survey
Get the link to the survey for the recipient
List all survey templates
Create a survey template
Get specified survey
Update a survey template
Deletes the specified survey
Update the content of a survey template
Update the email content of a survey template
Get recipient
Add recipient to survey
Get all answers to a survey
Get the number of answered/not answered
Statistics - Booking Usage
Recalculate
Booking - Articles
Article_GetAll
Article_Create
Article_GetBulk
Article_Get
Article_Update
Article_Delete
Articlegroups
ArticleGroup_GetAll
ArticleGroup_Create
ArticleGroup_Get
ArticleGroup_Update
ArticleGroup_Delete
Booking - Contact/Customer connections
Get all contact customer connections
Create a contact customer connection
Get a contact customer connection by id
Update a contact customer connection by id
Delete a contact customer connection by id
Booking - ContactFilter
ContactFilter_Get
ContactFilter_Create
ContactFilter_Update
Booking - Contacts
Get all contact by query
Create a contact
Get a contact by id
Update contact by id
Get visits statistics for contacts that has bookings in the timerange
Contacts_GuestServiceBusListenerAction
Booking - Customers
Get customers
Create a customer
Get a customer by id
Update a customer by id
Booking - Department
Department_Get
Department_Create
Department_Update
Booking - TestData
TestData_Create
Booking - Units
Unit_GetAll
Unit_Create
Unit_Get
Unit_Update
Campaigns
Campaign_GetAll
Campaign_Create
Campaign_Get
Campaign_Update
Campaign_Delete
Campaign_BatchCreate
Campaign_BatchDelete
Booking - Checkout
Create a booking to be invoiced
Cancel a booking that was created to be invoiced
CheckoutBookings_GetInvoicableCustomers
CheckoutBookings_GetEventTagProjects
CheckoutBookings_GetBriljantProjects
Check-In booking
Check-Out booking, add a payment of type invoice to mark booking for invoicing
Checkout
Get table map valid at date
List tables grouped by units and sections along with their bookings that overlaps the specified date
Booking - Menus
Gets specified menu
Respond to specified menu
Images
Image_Upload
Image_AddMeta
Analytics Storage API
Overview
ExportApi
ExportApi_Sales
ExportApi_SalesPeriod
ImportApi
ImportApi_Upload
Article
Article_UpdateArticleCosts
Payment API
Overview
Charges
Overview
Get Charges
Create a Charge
Capture a Charge
Create a Refund
Get Terminal
Get a verification
Post a Verifcation
Invoices
Overview
Get Invoice
Cancel Invoice
SubscriptionPlans
Overview
Get a SubscriptionPlan
Update a SubscriptionPlan
Create a SubscriptionPlan
Subscriptions
Overview
Get a Subscription
Cancel a Subscription
Create a Subscription
Authentications
Overview
Authentication Request
Customers
Overview
Create a Customer
Get a Customer
Update a Customer
Deleting card
Merchants
Overview
Update a Merchant
Create a Merchant
Get a Merchant
Delete a Merchant
Distributors
Overview
Update an Distributor
Create a Distributor
Get a Distributor
Delete an Distributor
Bank account number
Overview
Get bank account info
On this page
Overview
Authentications
Operations
Overview
Authentications
Section titled “Authentications”
The
Authentication API
provides functionality for authentication of users.
Operations
Section titled “Operations”
POST
/authentication