Simplybook.me User API

https://user-api.simplybook.me/
Admin
Simplybook.me User API provides JSON-RPC 2.0 endpoints for managing bookings, services, providers,...
Tokens:15,641
Snippets:93
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### POST /api/users - Get Promotion Reward Info

Source: https://user-api.simplybook.me

Retrieves information about a promotion reward.

```APIDOC
## POST /api/users - Get Promotion Reward Info

### Description
Retrieves information about a promotion reward.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **commonPromotionId** (object) - Required - The common ID of the promotion.
- **clientId** (object) - Required - The ID of the client.
- **hash** (object) - Required - The hash for verification.

### Response
#### Success Response (200)
- **object** - Information about the promotion reward.
#### Success Response (null)
- **null** - If the promotion reward information is not found.
```

--------------------------------

### POST /api/users - Get Promocode Info

Source: https://user-api.simplybook.me

Retrieves information about a promotional code.

```APIDOC
## POST /api/users - Get Promocode Info

### Description
Retrieves information about a promotional code.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **code** (object) - Required - The promotional code.

### Response
#### Success Response (200)
- **object** - Information about the promo code.
#### Success Response (null)
- **null** - If the promo code is not found.
```

--------------------------------

### POST /api/users - Get User License Text

Source: https://user-api.simplybook.me

Retrieves the user license text.

```APIDOC
## POST /api/users - Get User License Text

### Description
Retrieves the user license text.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
(No parameters required)

### Response
#### Success Response (200)
- **object** - The user license text.
```

--------------------------------

### POST /api/users - Get Booking

Source: https://user-api.simplybook.me

Retrieves information about a specific booking.

```APIDOC
## POST /api/users - Get Booking

### Description
Retrieves information about a specific booking.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **id** (object) - Required - The ID of the booking.
- **sign** (object) - Required - The signature for the request.

### Response
#### Success Response (200)
- **object** - Details of the booking.
```

--------------------------------

### POST /api/users - Get Booking Details

Source: https://user-api.simplybook.me

Retrieves detailed information about a specific booking.

```APIDOC
## POST /api/users - Get Booking Details

### Description
Retrieves detailed information about a specific booking.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **id** (object) - Required - The ID of the booking.
- **sign** (object) - Required - The signature for the request.

### Response
#### Success Response (200)
- **object** - Detailed information about the booking.
```

--------------------------------

### GET /api/users/{id}

Source: https://user-api.simplybook.me

Retrieves a specific user by ID.

```APIDOC
## GET /api/users/{id}

### Description
Retrieves a specific user by ID.

### Method
GET

### Endpoint
/api/users/{id}

### Path Parameters
- **id** (integer) - Required - The ID of the user to retrieve.

### Response
#### Success Response (200)
- **id** (integer) - The ID of the user.
- **name** (string) - The name of the user.
- **email** (string) - The email address of the user.

#### Response Example
{
  "id": 1,
  "name": "John Doe",
  "email": "john.doe@example.com"
}
```

--------------------------------

### GET /api/users

Source: https://user-api.simplybook.me

Retrieves a list of users. Supports filtering and pagination.

```APIDOC
## GET /api/users

### Description
Retrieves a list of users. Supports filtering and pagination.

### Method
GET

### Endpoint
/api/users

### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **limit** (integer) - Optional - The number of users per page.
- **isVisibleOnly** (boolean) - Optional - Filter for visible users only.
- **asArray** (boolean) - Optional - Return results as an array.
- **handleClasses** (integer) - Optional - Filter by class handle.
- **searchString** (string) - Optional - Search string for filtering users.

### Response
#### Success Response (200)
- **users** (array) - An array of user objects.

#### Response Example
{
  "users": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "john.doe@example.com"
    }
  ]
}
```

--------------------------------

### POST /api/users - Get Recurring Datetimes

Source: https://user-api.simplybook.me

Retrieves available datetimes for recurring bookings.

```APIDOC
## POST /api/users - Get Recurring Datetimes

### Description
Retrieves available datetimes for recurring bookings.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **eventId** (object) - Required - The ID of the event.
- **unitId** (object) - Required - The ID of the unit.
- **date** (any) - Required - The starting date.
- **time** (any) - Required - The starting time.
- **recurringData** (any) - Optional - Data for recurring bookings.
- **productIds** (any) - Optional - IDs of products. Defaults to [].
- **clientId** (any) - Optional - The client ID.
- **skipMembership** (any) - Optional - Whether to skip membership checks. Defaults to false.

### Response
#### Success Response (200)
- **array** - Available datetimes for recurring bookings.
```

--------------------------------

### POST /calculateEndTime

Source: https://user-api.simplybook.me

Calculates the end time for a booking based on start time, event, and unit details.

```APIDOC
## POST /calculateEndTime

### Description
Calculates the end time of a service event.

### Method
POST

### Parameters
#### Request Body
- **startDateTime** (object) - Required - The start date and time.
- **eventId** (object) - Required - The ID of the event.
- **unitId** (object) - Required - The ID of the unit.
- **productIds** (array) - Optional - List of product IDs (default: []).

### Response
#### Success Response (200)
- **result** (object) - The calculated end time details.
```

--------------------------------

### POST /signUpClient

Source: https://user-api.simplybook.me

Registers a new client in the system.

```APIDOC
## POST /signUpClient

### Description
Registers a new client account.

### Method
POST

### Parameters
#### Request Body
- **data** (object) - Required - The client registration data.
```

--------------------------------

### POST /api/clients/signUpClient

Source: https://user-api.simplybook.me

Signs up a new client.

```APIDOC
## POST /api/clients/signUpClient

### Description
Signs up a new client.

### Method
POST

### Endpoint
/api/clients/signUpClient

### Parameters
#### Request Body
- **data** (object) - Required - The data for the new client.

### Response
#### Success Response (200)
- **array** (array) - An array indicating the result of the sign-up.
```

--------------------------------

### POST /api/user/createBatch

Source: https://user-api.simplybook.me

Creates a batch process.

```APIDOC
## POST /api/user/createBatch

### Description
Initiates the creation of a batch process.

### Method
POST

### Endpoint
/api/user/createBatch

### Parameters
No parameters required.

### Response
#### Success Response (200)
- Returns an object, indicating the result of the batch creation.
```

--------------------------------

### POST /addClient

Source: https://user-api.simplybook.me

Adds a new client to the system.

```APIDOC
## POST /addClient

### Description
Registers a new client in the system.

### Method
POST

### Parameters
#### Request Body
- **data** (object) - Required - Client information data.

### Response
#### Success Response (200)
- **returns** (array) - Returns an array containing the new client details.
```

--------------------------------

### POST /api/user/getPluginStatuses

Source: https://user-api.simplybook.me

Retrieves the activation statuses for a list of plugins.

```APIDOC
## POST /api/user/getPluginStatuses

### Description
Retrieves the activation statuses for a list of specified plugins.

### Method
POST

### Endpoint
/api/user/getPluginStatuses

### Parameters
#### Request Body
- **pluginNames** (object) - Required - An object containing the names of the plugins to check.

### Response
#### Success Response (200)
- Returns an object, containing the status of each requested plugin.
```

--------------------------------

### POST /api/user/getCompanyInfo

Source: https://user-api.simplybook.me

Retrieves general company information.

```APIDOC
## POST /api/user/getCompanyInfo

### Description
Retrieves general information about the company.

### Method
POST

### Endpoint
/api/user/getCompanyInfo

### Parameters
No parameters required.

### Response
#### Success Response (200)
- Returns an object, containing company information.
```

--------------------------------

### POST /api/user/getPluginPromoInfoByCode

Source: https://user-api.simplybook.me

Retrieves promotional information for a plugin using its code.

```APIDOC
## POST /api/user/getPluginPromoInfoByCode

### Description
Retrieves promotional information for a specific plugin identified by its code.

### Method
POST

### Endpoint
/api/user/getPluginPromoInfoByCode

### Parameters
#### Request Body
- **code** (object) - Required - The promotional code for the plugin.

### Response
#### Success Response (200)
- Returns an object, containing the promotional information.
```

--------------------------------

### POST /api/clients/sendSignUpClientEmail

Source: https://user-api.simplybook.me

Sends a sign-up confirmation email to a client.

```APIDOC
## POST /api/clients/sendSignUpClientEmail

### Description
Sends a sign-up confirmation email to a client.

### Method
POST

### Endpoint
/api/clients/sendSignUpClientEmail

### Parameters
#### Request Body
- **client** (any) - Required - The client object for whom to send the email.

### Response
#### Success Response (200)
- **null** - Indicates the email was sent successfully.
```

--------------------------------

### POST /api/bookings/addToWaitingList

Source: https://user-api.simplybook.me

Adds a client to the waiting list for an event.

```APIDOC
## POST /api/bookings/addToWaitingList

### Description
Adds a client to the waiting list for an event.

### Method
POST

### Endpoint
/api/bookings/addToWaitingList

### Parameters
#### Request Body
- **eventId** (any) - Required - The ID of the event.
- **unitId** (any) - Required - The ID of the unit.
- **date** (any) - Required - The date of the booking.
- **time** (any) - Required - The time of the booking.
- **clientData** (any) - Required - Data of the client.
- **additional** (any) - Optional - Additional information. Defaults to [].
- **count** (any) - Optional - The number of spots to reserve. Defaults to 1.

### Response
#### Success Response (200)
- **null** - Indicates success.
- **null** - Indicates success.
- **null** - Indicates success.
```

--------------------------------

### POST /api/users

Source: https://user-api.simplybook.me

Creates a new user.

```APIDOC
## POST /api/users

### Description
Creates a new user.

### Method
POST

### Endpoint
/api/users

### Request Body
- **name** (string) - Required - The name of the user.
- **email** (string) - Required - The email address of the user.

### Request Example
{
  "name": "Jane Doe",
  "email": "jane.doe@example.com"
}

### Response
#### Success Response (201)
- **id** (integer) - The ID of the newly created user.
- **name** (string) - The name of the user.
- **email** (string) - The email address of the user.

#### Response Example
{
  "id": 2,
  "name": "Jane Doe",
  "email": "jane.doe@example.com"
}
```

--------------------------------

### POST /api/payment-systems

Source: https://user-api.simplybook.me

Retrieves a list of allowed payment systems.

```APIDOC
## POST /api/payment-systems

### Description
Retrieves a list of allowed payment systems.

### Method
POST

### Endpoint
/api/payment-systems

### Response
#### Success Response (200)
- **paymentSystems** (object) - An object containing allowed payment systems.

#### Response Example
{
  "paymentSystems": {
    "paypal": true,
    "creditCard": true
  }
}
```

--------------------------------

### POST /api/promotions/getPromocodeInfo

Source: https://user-api.simplybook.me

Retrieves information about a promotional code.

```APIDOC
## POST /api/promotions/getPromocodeInfo

### Description
Retrieves information about a promotional code.

### Method
POST

### Endpoint
/api/promotions/getPromocodeInfo

### Parameters
#### Request Body
- **code** (object) - Required - The promotional code.

### Response
#### Success Response (200)
- **object** (object) - Information about the promotional code.
- **null** - Indicates the code was not found or is invalid.
```

--------------------------------

### POST /api/promotions/getPromotionRewardInfo

Source: https://user-api.simplybook.me

Retrieves information about a promotion reward.

```APIDOC
## POST /api/promotions/getPromotionRewardInfo

### Description
Retrieves information about a promotion reward.

### Method
POST

### Endpoint
/api/promotions/getPromotionRewardInfo

### Parameters
#### Request Body
- **commonPromotionId** (object) - Required - The common ID of the promotion.
- **clientId** (object) - Required - The ID of the client.
- **hash** (object) - Required - The hash for verification.

### Response
#### Success Response (200)
- **object** (object) - Information about the promotion reward.
- **null** - Indicates the reward information could not be retrieved.
```

--------------------------------

### POST /api/payment-processor-config

Source: https://user-api.simplybook.me

Retrieves configuration for a specific payment processor.

```APIDOC
## POST /api/payment-processor-config

### Description
Retrieves configuration for a specific payment processor.

### Method
POST

### Endpoint
/api/payment-processor-config

### Request Body
- **paymentProcessor** (object) - Required - The payment processor for which to retrieve configuration.

### Response
#### Success Response (200)
- **config** (object) - Payment processor configuration details.

#### Response Example
{
  "config": {
    "apiKey": "YOUR_API_KEY"
  }
}
```

--------------------------------

### POST /api/clients/getClientInfoByOpenIdToken

Source: https://user-api.simplybook.me

Retrieves client information using an OpenID token.

```APIDOC
## POST /api/clients/getClientInfoByOpenIdToken

### Description
Retrieves client information using an OpenID token.

### Method
POST

### Endpoint
/api/clients/getClientInfoByOpenIdToken

### Parameters
#### Request Body
- **token** (object) - Required - The OpenID token.
- **provider** (object) - Required - The OpenID provider.

### Response
#### Success Response (200)
- **object** (object) - The client information.
```

--------------------------------

### POST /api/promotions/hasUpcommingPromotions

Source: https://user-api.simplybook.me

Checks if there are any upcoming promotions.

```APIDOC
## POST /api/promotions/hasUpcommingPromotions

### Description
Checks if there are any upcoming promotions.

### Method
POST

### Endpoint
/api/promotions/hasUpcommingPromotions

### Parameters
#### Request Body
(No parameters required)

### Response
#### Success Response (200)
- **object** (object) - An object indicating whether there are upcoming promotions.
```

--------------------------------

### POST /api/users - Add to Waiting List

Source: https://user-api.simplybook.me

Adds a client to the waiting list for an event.

```APIDOC
## POST /api/users - Add to Waiting List

### Description
Adds a client to the waiting list for an event.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **eventId** (any) - Required - The ID of the event.
- **unitId** (any) - Required - The ID of the unit.
- **date** (any) - Required - The date of the event.
- **time** (any) - Required - The time of the event.
- **clientData** (any) - Required - Data of the client.
- **additional** (any) - Optional - Additional information. Defaults to [].
- **count** (any) - Optional - The number of spots to reserve. Defaults to 1.

### Response
#### Success Response (200)
- **null** - Indicates the client was added to the waiting list.
```

--------------------------------

### POST /getCompanyParam

Source: https://user-api.simplybook.me

Retrieves a specific company parameter by its key.

```APIDOC
## POST /getCompanyParam

### Description
Retrieves a specific company parameter value based on the provided key.

### Method
POST

### Parameters
#### Request Body
- **key** (object) - Required - The key of the company parameter to retrieve.

### Response
#### Success Response (200)
- **result** (any) - The value associated with the requested key.
```

--------------------------------

### POST /api/user/getProductCategoriesList

Source: https://user-api.simplybook.me

Retrieves a list of product categories, with optional filtering.

```APIDOC
## POST /api/user/getProductCategoriesList

### Description
Retrieves a list of product categories. An optional filter can be applied.

### Method
POST

### Endpoint
/api/user/getProductCategoriesList

### Parameters
#### Request Body
- **filter** (any) - Optional - A filter to apply to the product categories list.

### Response
#### Success Response (200)
- Returns an array of arrays, representing the product categories list, or null.
```

--------------------------------

### POST /getClientInfo

Source: https://user-api.simplybook.me

Retrieves information for a specific client.

```APIDOC
## POST /getClientInfo

### Description
Retrieves detailed information for a specific client using their ID and signature.

### Method
POST

### Parameters
#### Request Body
- **clientId** (object) - Required - The unique identifier for the client.
- **sign** (object) - Required - The security signature for the request.
```

--------------------------------

### POST /api/bookings/getBookingDetails

Source: https://user-api.simplybook.me

Retrieves detailed information about a specific booking.

```APIDOC
## POST /api/bookings/getBookingDetails

### Description
Retrieves detailed information about a specific booking.

### Method
POST

### Endpoint
/api/bookings/getBookingDetails

### Parameters
#### Request Body
- **id** (object) - Required - The ID of the booking to retrieve.
- **sign** (object) - Required - The sign associated with the booking.

### Response
#### Success Response (200)
- **object** (object) - The detailed booking information.
```

--------------------------------

### POST /api/booking-cart/info-zero-prices

Source: https://user-api.simplybook.me

Retrieves booking cart information with zero prices.

```APIDOC
## POST /api/booking-cart/info-zero-prices

### Description
Retrieves booking cart information with zero prices.

### Method
POST

### Endpoint
/api/booking-cart/info-zero-prices

### Request Body
- **cartId** (object) - Required - The ID of the booking cart.
- **sign** (object) - Required - Signature for verification.

### Response
#### Success Response (200)
- **bookingCartInfo** (object) - Booking cart information with zero prices.

#### Response Example
{
  "bookingCartInfo": {
    "status": "active",
    "totalAmount": 0
  }
}
```

--------------------------------

### POST /api/booking/confirm-batch

Source: https://user-api.simplybook.me

Confirms a batch of bookings.

```APIDOC
## POST /api/booking/confirm-batch

### Description
Confirms a batch of bookings.

### Method
POST

### Endpoint
/api/booking/confirm-batch

### Request Body
- **batchId** (object) - Required - The ID of the batch.
- **batchType** (object) - Required - The type of the batch.
- **sign** (object) - Required - Signature for verification.

### Response
#### Success Response (200)
- **confirmation** (object) - Batch confirmation details.

#### Response Example
{
  "confirmation": {
    "status": "confirmed",
    "batchId": "BATCH001"
  }
}
```

--------------------------------

### POST /api/users - Book

Source: https://user-api.simplybook.me

Books an event for a client.

```APIDOC
## POST /api/users - Book

### Description
Books an event for a client.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **eventId** (object) - Required - The ID of the event.
- **unitId** (object) - Required - The ID of the unit.
- **date** (object) - Required - The date of the booking.
- **time** (object) - Required - The time of the booking.
- **clientData** (object|array) - Required - Data of the client.
- **additional** (array|object) - Optional - Additional information. Defaults to [].
- **count** (object) - Optional - The number of spots to book. Defaults to 1.
- **batchId** (object) - Optional - The ID of the batch if part of a batch booking.
- **recurringData** (object) - Optional - Data for recurring bookings.

### Response
#### Success Response (200)
- **object** - Details of the booking.
```

--------------------------------

### POST /api/users/getUserLicenseText

Source: https://user-api.simplybook.me

Retrieves the user license text.

```APIDOC
## POST /api/users/getUserLicenseText

### Description
Retrieves the user license text.

### Method
POST

### Endpoint
/api/users/getUserLicenseText

### Parameters
#### Request Body
(No parameters required)

### Response
#### Success Response (200)
- **object** (object) - The user license text.
```

--------------------------------

### POST /api/bookings/getBooking

Source: https://user-api.simplybook.me

Retrieves information about a specific booking.

```APIDOC
## POST /api/bookings/getBooking

### Description
Retrieves information about a specific booking.

### Method
POST

### Endpoint
/api/bookings/getBooking

### Parameters
#### Request Body
- **id** (object) - Required - The ID of the booking to retrieve.
- **sign** (object) - Required - The sign associated with the booking.

### Response
#### Success Response (200)
- **object** (object) - The booking details.
```

--------------------------------

### POST /api/clients/getClientInfo

Source: https://user-api.simplybook.me

Retrieves information about a specific client.

```APIDOC
## POST /api/clients/getClientInfo

### Description
Retrieves information about a specific client.

### Method
POST

### Endpoint
/api/clients/getClientInfo

### Parameters
#### Request Body
- **clientId** (object) - Required - The ID of the client.
- **sign** (object) - Required - The sign associated with the client.

### Response
#### Success Response (200)
- **object** (object) - The client information.
```

--------------------------------

### POST /getClientByLoginHash

Source: https://user-api.simplybook.me

Retrieves client information using a login hash.

```APIDOC
## POST /getClientByLoginHash

### Description
Retrieves client details based on a provided login hash.

### Method
POST

### Parameters
#### Request Body
- **hash** (object) - Required - The login hash.
- **setExpired** (object) - Optional (default: false) - Whether to set the hash as expired.
- **expireOtherHashes** (object) - Optional - Whether to expire other associated hashes.

### Response
#### Success Response (200)
- **returns** (object) - Returns client object details.
```

--------------------------------

### POST /api/users - Has Upcoming Promotions

Source: https://user-api.simplybook.me

Checks if there are any upcoming promotions.

```APIDOC
## POST /api/users - Has Upcoming Promotions

### Description
Checks if there are any upcoming promotions.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
(No parameters required)

### Response
#### Success Response (200)
- **object** - Indicates whether there are upcoming promotions.
```

--------------------------------

### POST /api/bookings/book

Source: https://user-api.simplybook.me

Books an event for a client.

```APIDOC
## POST /api/bookings/book

### Description
Books an event for a client.

### Method
POST

### Endpoint
/api/bookings/book

### Parameters
#### Request Body
- **eventId** (object) - Required - The ID of the event.
- **unitId** (object) - Required - The ID of the unit.
- **date** (object) - Required - The date of the booking.
- **time** (object) - Required - The time of the booking.
- **clientData** (object|array) - Required - Data of the client.
- **additional** (array|object) - Optional - Additional information. Defaults to [].
- **count** (object) - Optional - The number of spots to book. Defaults to 1.
- **batchId** (object) - Optional - The ID of the batch booking.
- **recurringData** (object) - Optional - Data for recurring bookings.

### Response
#### Success Response (200)
- **object** (object) - Details of the booking. (Multiple objects may be returned, each representing a booking detail).
```

--------------------------------

### POST /api/booking/confirm-batch-payment

Source: https://user-api.simplybook.me

Confirms payment for a batch of bookings.

```APIDOC
## POST /api/booking/confirm-batch-payment

### Description
Confirms payment for a batch of bookings.

### Method
POST

### Endpoint
/api/booking/confirm-batch-payment

### Request Body
- **batchId** (object) - Required - The ID of the batch.
- **batchType** (object) - Required - The type of the batch.
- **paymentProcessor** (object) - Required - The payment processor used.
- **sign** (object) - Required - Signature for verification.

### Response
#### Success Response (200)
- **confirmation** (object) - Batch payment confirmation details.

#### Response Example
{
  "confirmation": {
    "status": "paid",
    "batchId": "BATCH001"
  }
}
```

--------------------------------

### Plugin Management API

Source: https://user-api.simplybook.me

Endpoints for managing plugin statuses and information.

```APIDOC
## POST /api/plugins/isActivated

### Description
Checks if a specific plugin is activated.

### Method
POST

### Endpoint
/api/plugins/isActivated

### Parameters
#### Request Body
- **pluginName** (object) - Required - The name of the plugin to check.

### Response
#### Success Response (200)
- **status** (object) - Indicates if the plugin is activated.

### Response Example
```json
{
  "status": true
}
```
```

```APIDOC
## POST /api/plugins/getStatuses

### Description
Retrieves the activation statuses for a list of plugins.

### Method
POST

### Endpoint
/api/plugins/getStatuses

### Parameters
#### Request Body
- **pluginNames** (object) - Required - An array of plugin names.

### Response
#### Success Response (200)
- **statuses** (object) - An object containing the activation status for each plugin.

### Response Example
```json
{
  "statuses": {
    "plugin1": true,
    "plugin2": false
  }
}
```
```

```APIDOC
## POST /api/plugins/getPromoInfoByCode

### Description
Retrieves promotional information for a plugin using its code.

### Method
POST

### Endpoint
/api/plugins/getPromoInfoByCode

### Parameters
#### Request Body
- **code** (object) - Required - The promotional code for the plugin.

### Response
#### Success Response (200)
- **promoInfo** (object) - Promotional details for the plugin.

### Response Example
```json
{
  "promoInfo": {
    "discount": "10%",
    "validUntil": "2024-12-31"
  }
}
```
```

--------------------------------

### POST /api/booking-cart/info

Source: https://user-api.simplybook.me

Retrieves detailed information about a booking cart.

```APIDOC
## POST /api/booking-cart/info

### Description
Retrieves detailed information about a booking cart.

### Method
POST

### Endpoint
/api/booking-cart/info

### Request Body
- **cartId** (object) - Required - The ID of the booking cart.
- **sign** (object) - Required - Signature for verification.

### Response
#### Success Response (200)
- **bookingCartInfo** (object) - Detailed booking cart information.

#### Response Example
{
  "bookingCartInfo": {
    "status": "active",
    "totalAmount": 100
  }
}
```

--------------------------------

### POST /api/clients/getClientInfoByLoginPassword

Source: https://user-api.simplybook.me

Retrieves client information using login credentials.

```APIDOC
## POST /api/clients/getClientInfoByLoginPassword

### Description
Retrieves client information using login credentials.

### Method
POST

### Endpoint
/api/clients/getClientInfoByLoginPassword

### Parameters
#### Request Body
- **login** (object) - Required - The client's login.
- **password** (object) - Required - The client's password.

### Response
#### Success Response (200)
- **object** (object) - The client information.
```

--------------------------------

### POST /api/clients/remindClientPassword

Source: https://user-api.simplybook.me

Initiates the password reminder process for a client.

```APIDOC
## POST /api/clients/remindClientPassword

### Description
Initiates the password reminder process for a client.

### Method
POST

### Endpoint
/api/clients/remindClientPassword

### Parameters
#### Request Body
(Parameters not specified in the provided text)

### Response
#### Success Response (200)
(Response details not specified in the provided text)
```

--------------------------------

### POST /api/users - Confirm Booking Batch Payment

Source: https://user-api.simplybook.me

Confirms the payment for a batch of bookings.

```APIDOC
## POST /api/users - Confirm Booking Batch Payment

### Description
Confirms the payment for a batch of bookings.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **batchId** (object) - Required - The ID of the batch.
- **batchType** (object) - Required - The type of the batch.
- **paymentProcessor** (object) - Required - The payment processor used.
- **sign** (object) - Required - The signature for the request.

### Response
#### Success Response (200)
- **object** - The result of the confirmation.
```

--------------------------------

### POST /api/user/checkAvailability

Source: https://user-api.simplybook.me

Checks the availability of units for a given event and time.

```APIDOC
## POST /api/user/checkAvailability

### Description
Checks the availability of units for a given event and time, with optional parameters for count, unit ID, and product IDs.

### Method
POST

### Endpoint
/api/user/checkAvailability

### Parameters
#### Request Body
- **eventId** (object) - Required - The ID of the event.
- **dateTime** (object) - Required - The date and time for the availability check.
- **count** (integer) - Optional - The number of units to check for. Defaults to 1.
- **unitId** (integer) - Optional - The ID of the unit to check.
- **productIds** (array) - Optional - A list of product IDs to consider. Defaults to an empty array.

### Response
#### Success Response (200)
- Returns an array of arrays, representing availability information.
```

--------------------------------

### POST getAvailableUnits

Source: https://user-api.simplybook.me

Retrieves available units for a specific event and time.

```APIDOC
## POST getAvailableUnits

### Description
Retrieves available units for a specific event and time.

### Method
POST

### Parameters
#### Request Body
- **eventId** (object) - Required
- **dateTime** (object) - Required
- **count** (integer) - Optional (Default: 1)
- **unitId** (integer) - Optional
- **productIds** (array) - Optional (Default: [])
```

--------------------------------

### POST /api/batch/close

Source: https://user-api.simplybook.me

Closes a batch.

```APIDOC
## POST /api/batch/close

### Description
Closes a batch.

### Method
POST

### Endpoint
/api/batch/close

### Request Body
- **batchId** (any) - Required - The ID of the batch.
- **batchType** (any) - Required - The type of the batch.
- **sign** (any) - Required - Signature for verification.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Batch closed successfully."
}
```

--------------------------------

### POST /api/booking-cart

Source: https://user-api.simplybook.me

Retrieves booking cart information.

```APIDOC
## POST /api/booking-cart

### Description
Retrieves booking cart information.

### Method
POST

### Endpoint
/api/booking-cart

### Request Body
- **bookingIds** (object) - Required - An object containing booking IDs.

### Response
#### Success Response (200)
- **bookingCart** (object) - Booking cart details.

#### Response Example
{
  "bookingCart": {
    "id": "bc456",
    "items": [],
    "total": 0
  }
}
```

--------------------------------

### POST /api/bookings/cancelBatch

Source: https://user-api.simplybook.me

Cancels multiple bookings in a batch.

```APIDOC
## POST /api/bookings/cancelBatch

### Description
Cancels multiple bookings in a batch.

### Method
POST

### Endpoint
/api/bookings/cancelBatch

### Parameters
#### Request Body
- **id** (object) - Required - Identifier for the cancellation request.
- **bookingIdsWithSign** (object) - Required - List of booking IDs and their associated signs to cancel.
- **reason** (string) - Optional - The reason for cancellation. Defaults to "".

### Response
#### Success Response (200)
- **object** (object) - Description of the first returned object.
- **object** (object) - Description of the second returned object.
```

--------------------------------

### POST /api/users - Is Payment Required

Source: https://user-api.simplybook.me

Checks if payment is required for an event.

```APIDOC
## POST /api/users - Is Payment Required

### Description
Checks if payment is required for an event.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **eventId** (object) - Optional - The ID of the event.

### Response
#### Success Response (200)
- **object** - Indicates whether payment is required.
```

--------------------------------

### POST /api/user/getAnyUnitData

Source: https://user-api.simplybook.me

Retrieves any unit data, with an option to skip default texts.

```APIDOC
## POST /api/user/getAnyUnitData

### Description
Retrieves unit data. Allows skipping default texts.

### Method
POST

### Endpoint
/api/user/getAnyUnitData

### Parameters
#### Request Body
- **skipDefaultTexts** (any) - Optional - Whether to skip default texts. Defaults to false.

### Response
#### Success Response (200)
- Returns an object or null, representing unit data.
```

--------------------------------

### POST /api/paypal/information

Source: https://user-api.simplybook.me

Retrieves PayPal information.

```APIDOC
## POST /api/paypal/information

### Description
Retrieves PayPal information.

### Method
POST

### Endpoint
/api/paypal/information

### Response
#### Success Response (200)
- **paypalInfo** (object) - PayPal information details.

#### Response Example
{
  "paypalInfo": {
    "clientId": "YOUR_CLIENT_ID",
    "secret": "YOUR_SECRET"
  }
}
```

--------------------------------

### POST /api/booking/confirm

Source: https://user-api.simplybook.me

Confirms a booking.

```APIDOC
## POST /api/booking/confirm

### Description
Confirms a booking.

### Method
POST

### Endpoint
/api/booking/confirm

### Request Body
- **id** (object) - Required - The ID of the booking.
- **sign** (object) - Required - Signature for verification.

### Response
#### Success Response (200)
- **confirmation** (object) - Confirmation details.

#### Response Example
{
  "confirmation": {
    "status": "confirmed",
    "bookingId": "B789"
  }
}
```

--------------------------------

### POST /api/user/getTimeframe

Source: https://user-api.simplybook.me

Retrieves the timeframe information.

```APIDOC
## POST /api/user/getTimeframe

### Description
Retrieves the timeframe information.

### Method
POST

### Endpoint
/api/user/getTimeframe

### Parameters
No parameters required.

### Response
#### Success Response (200)
- Returns an object, representing the timeframe.
```

--------------------------------

### POST /api/cart

Source: https://user-api.simplybook.me

Retrieves cart information.

```APIDOC
## POST /api/cart

### Description
Retrieves cart information.

### Method
POST

### Endpoint
/api/cart

### Request Body
- **bookingIds** (object) - Required - An object containing booking IDs.
- **paymentProcessor** (object) - Required - The payment processor to use.

### Response
#### Success Response (200)
- **cart** (object) - Cart details.

#### Response Example
{
  "cart": {
    "id": "cart123",
    "items": [],
    "total": 0
  }
}
```

--------------------------------

### POST /api/user/getCompanyTimezoneOffset

Source: https://user-api.simplybook.me

Retrieves the timezone offset for the company.

```APIDOC
## POST /api/user/getCompanyTimezoneOffset

### Description
Retrieves the timezone offset information for the company.

### Method
POST

### Endpoint
/api/user/getCompanyTimezoneOffset

### Parameters
No parameters required.

### Response
#### Success Response (200)
- Returns an array, representing the company's timezone offset.
```

--------------------------------

### POST /api/booking/confirm-payment

Source: https://user-api.simplybook.me

Confirms payment for a booking.

```APIDOC
## POST /api/booking/confirm-payment

### Description
Confirms payment for a booking.

### Method
POST

### Endpoint
/api/booking/confirm-payment

### Request Body
- **id** (object) - Required - The ID of the booking.
- **paymentProcessor** (object) - Required - The payment processor used.
- **sign** (object) - Required - Signature for verification.

### Response
#### Success Response (200)
- **confirmation** (object) - Payment confirmation details.

#### Response Example
{
  "confirmation": {
    "status": "paid",
    "transactionId": "T123"
  }
}
```

--------------------------------

### POST /getWorkDaysInfo

Source: https://user-api.simplybook.me

Retrieves information about working days within a specified range.

```APIDOC
## POST /getWorkDaysInfo

### Description
Returns information regarding working days for a specific unit and event.

### Method
POST

### Parameters
#### Request Body
- **from** (object) - Required - Start date.
- **to** (object) - Required - End date.
- **unitId** (object) - Optional - The unit ID.
- **eventId** (object) - Optional - The event ID.
- **count** (object) - Optional - Count (default: 1).
- **productIds** (array) - Optional - List of product IDs (default: []).

### Response
#### Success Response (200)
- **result** (array) - List of working day information.
```

--------------------------------

### POST /api/users - Validate Promo Code

Source: https://user-api.simplybook.me

Validates a promotional code.

```APIDOC
## POST /api/users - Validate Promo Code

### Description
Validates a promotional code.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **code** (object) - Required - The promotional code.
- **startDateTime** (object) - Required - The start date and time for validation.
- **eventId** (object) - Required - The ID of the event.
- **count** (object) - Optional - The number of uses. Defaults to 1.
- **clientData** (array|object) - Optional - Data of the client. Defaults to [].

### Response
#### Success Response (200)
- **object** - Information about the validated promo code.
```

--------------------------------

### POST /rescheduleBook

Source: https://user-api.simplybook.me

Reschedules an existing booking.

```APIDOC
## POST /rescheduleBook

### Description
Updates the schedule for an existing booking.

### Method
POST

### Parameters
#### Request Body
- **shedulerId** (integer) - Required - The ID of the booking to reschedule.
- **sign** (string) - Required - Security signature.
- **startDate** (object) - Required - New start date.
- **startTime** (object) - Required - New start time.
- **endDate** (object) - Optional - New end date.
- **endTime** (object) - Optional - New end time.
- **additional** (array) - Optional (default: []) - Additional parameters.
- **clientTimeOffset** (integer) - Optional (default: 0) - Client time offset.
- **clientTimezone** (string) - Optional - Client timezone string.
```

--------------------------------

### POST /rescheduleBook

Source: https://user-api.simplybook.me

Reschedules an existing booking.

```APIDOC
## POST /rescheduleBook

### Description
Updates the date and time for an existing booking.

### Method
POST

### Parameters
#### Request Body
- **shedulerId** (integer) - Required - The ID of the booking to reschedule.
- **sign** (string) - Required - The security signature.
- **startDate** (object) - Required - The new start date.
- **startTime** (object) - Required - The new start time.
- **endDate** (object) - Optional - The new end date.
- **endTime** (object) - Optional - The new end time.
- **additional** (array) - Optional - Additional parameters.
- **clientTimeOffset** (integer) - Optional - Time offset.
- **clientTimezone** (string) - Optional - Client timezone.
```

--------------------------------

### POST /api/promotions/validatePromoCode

Source: https://user-api.simplybook.me

Validates a promotional code for a booking.

```APIDOC
## POST /api/promotions/validatePromoCode

### Description
Validates a promotional code for a booking.

### Method
POST

### Endpoint
/api/promotions/validatePromoCode

### Parameters
#### Request Body
- **code** (object) - Required - The promotional code to validate.
- **startDateTime** (object) - Required - The start date and time for the booking.
- **eventId** (object) - Required - The ID of the event.
- **count** (object) - Optional - The number of items the promo code applies to. Defaults to 1.
- **clientData** (array|object) - Optional - Data of the client. Defaults to [].

### Response
#### Success Response (200)
- **object** (object) - Information about the validated promo code. (Multiple objects may be returned, each representing a validation result).
```

--------------------------------

### POST /api/users - Close Batch

Source: https://user-api.simplybook.me

Closes a batch of bookings.

```APIDOC
## POST /api/users - Close Batch

### Description
Closes a batch of bookings.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **batchId** (any) - Required - The ID of the batch.
- **batchType** (any) - Required - The type of the batch.
- **sign** (any) - Required - The signature for the request.

### Response
#### Success Response (200)
- **null** - Indicates the batch was closed successfully.
```

--------------------------------

### POST /api/booking-cart/confirm

Source: https://user-api.simplybook.me

Confirms a booking cart.

```APIDOC
## POST /api/booking-cart/confirm

### Description
Confirms a booking cart.

### Method
POST

### Endpoint
/api/booking-cart/confirm

### Request Body
- **cartId** (object) - Required - The ID of the booking cart.
- **paymentProcessor** (object) - Required - The payment processor to use.
- **sign** (object) - Required - Signature for verification.

### Response
#### Success Response (200)
- **confirmation** (object) - Confirmation details.

#### Response Example
{
  "confirmation": {
    "status": "confirmed",
    "bookingId": "B789"
  }
}
```

--------------------------------

### POST getAvailableTimeIntervals

Source: https://user-api.simplybook.me

Retrieves available time intervals for booking within a date range.

```APIDOC
## POST getAvailableTimeIntervals

### Description
Retrieves available time intervals for booking within a date range.

### Method
POST

### Parameters
#### Request Body
- **dateFrom** (object) - Required
- **dateTo** (object) - Required
- **eventId** (object) - Optional
- **unitId** (object) - Optional
- **count** (object) - Optional (Default: 1)
```

--------------------------------

### POST /api/booking-cart/status

Source: https://user-api.simplybook.me

Retrieves the status of a booking cart.

```APIDOC
## POST /api/booking-cart/status

### Description
Retrieves the status of a booking cart.

### Method
POST

### Endpoint
/api/booking-cart/status

### Request Body
- **id** (object) - Required - The ID of the booking cart.

### Response
#### Success Response (200)
- **status** (string) - The status of the booking cart.

#### Response Example
{
  "status": "confirmed"
}
```

--------------------------------

### POST /api/booking-cart/payment-page-url

Source: https://user-api.simplybook.me

Retrieves the URL for the booking cart payment page.

```APIDOC
## POST /api/booking-cart/payment-page-url

### Description
Retrieves the URL for the booking cart payment page.

### Method
POST

### Endpoint
/api/booking-cart/payment-page-url

### Request Body
- **cartId** (object) - Required - The ID of the booking cart.

### Response
#### Success Response (200)
- **paymentPageUrl** (string) - The URL for the payment page.

#### Response Example
{
  "paymentPageUrl": "https://example.com/pay?cartId=bc456"
}
```

--------------------------------

### POST /api/users - Cancel Batch

Source: https://user-api.simplybook.me

Cancels a batch of bookings.

```APIDOC
## POST /api/users - Cancel Batch

### Description
Cancels a batch of bookings.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **id** (object) - Required - The ID of the batch.
- **bookingIdsWithSign** (object) - Required - The IDs of the bookings to cancel with their signatures.
- **reason** (object) - Optional - The reason for cancellation. Defaults to "".

### Response
#### Success Response (200)
- **object** - Details of the cancelled bookings.
```
Tokens:
Raw