# BookingsApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addBookingSpaceTier**](#addbookingspacetier) | **POST** /bookings/spaces/{spaceId}/tiers/{tierId} | Add an account tier to a booking space|
|[**cancelBooking**](#cancelbooking) | **PUT** /bookings/spaces/{spaceId}/bookings/{bookingId}/cancel | Cancel a booking|
|[**checkInBooking**](#checkinbooking) | **POST** /bookings/spaces/{spaceId}/bookings/{bookingId}/checkin | Check in a booking|
|[**createBooking**](#createbooking) | **POST** /bookings/spaces/{spaceId}/bookings | Create a booking for a space|
|[**deleteBooking**](#deletebooking) | **DELETE** /bookings/spaces/{spaceId}/bookings/{bookingId} | Delete a booking|
|[**getBooking**](#getbooking) | **GET** /bookings/{bookingId} | Get a booking|
|[**getBookingPlace**](#getbookingplace) | **GET** /bookings/places/{placeId} | Get a booking place|
|[**getBookingPlaceBookings**](#getbookingplacebookings) | **GET** /bookings/places/{placeId}/bookings | List a booking place\'s bookings|
|[**getBookingPlacePayments**](#getbookingplacepayments) | **GET** /bookings/places/{placeId}/payments | List a booking place\'s payments|
|[**getBookingPlaceTranslation**](#getbookingplacetranslation) | **GET** /bookings/places/{placeId}/translations/{locale} | Get a booking place\'s translation|
|[**getBookingPlaceTranslations**](#getbookingplacetranslations) | **GET** /bookings/places/{placeId}/translations | List a booking place\'s translations|
|[**getBookingPlaces**](#getbookingplaces) | **GET** /bookings/places | List booking places|
|[**getBookingResponses**](#getbookingresponses) | **GET** /bookings/{bookingId}/responses | List a booking\'s question responses|
|[**getBookingSpace**](#getbookingspace) | **GET** /bookings/spaces/{spaceId} | Get a booking space|
|[**getBookingSpaceAvailabilities**](#getbookingspaceavailabilities) | **GET** /bookings/spaces/{spaceId}/availabilities | List a booking space\'s weekly availability rules|
|[**getBookingSpaceAvailability**](#getbookingspaceavailability) | **GET** /bookings/spaces/{spaceId}/availabilities/{availabilityId} | Get a booking space availability by id|
|[**getBookingSpaceBlackout**](#getbookingspaceblackout) | **GET** /bookings/spaces/{spaceId}/blackouts/{blackoutId} | Get a booking space blackout|
|[**getBookingSpaceBlackouts**](#getbookingspaceblackouts) | **GET** /bookings/spaces/{spaceId}/blackouts | List a booking space\'s blackouts|
|[**getBookingSpaceBookings**](#getbookingspacebookings) | **GET** /bookings/spaces/{spaceId}/bookings | List a booking space\'s bookings|
|[**getBookingSpacePayments**](#getbookingspacepayments) | **GET** /bookings/spaces/{spaceId}/payments | List a booking space\'s payments|
|[**getBookingSpaceSlots**](#getbookingspaceslots) | **GET** /bookings/spaces/{spaceId}/slots | Get a booking space\'s available slots|
|[**getBookingSpaceTiers**](#getbookingspacetiers) | **GET** /bookings/spaces/{spaceId}/tiers | List a booking space\'s assigned tiers|
|[**getBookingSpaceTranslation**](#getbookingspacetranslation) | **GET** /bookings/spaces/{spaceId}/translations/{locale} | Get a booking space\'s translation for a locale|
|[**getBookingSpaceTranslations**](#getbookingspacetranslations) | **GET** /bookings/spaces/{spaceId}/translations | List a booking space\'s translations|
|[**getBookingSpaces**](#getbookingspaces) | **GET** /bookings/spaces | List booking spaces|
|[**removeBookingSpaceTier**](#removebookingspacetier) | **DELETE** /bookings/spaces/{spaceId}/tiers/{tierId} | Remove an account tier from a booking space|
|[**undoCheckInBooking**](#undocheckinbooking) | **POST** /bookings/spaces/{spaceId}/bookings/{bookingId}/checkin/undo | Undo a booking check-in|
|[**updateBooking**](#updatebooking) | **PUT** /bookings/spaces/{spaceId}/bookings/{bookingId} | Update a booking|

# **addBookingSpaceTier**
> CreateBookingSpace200Response addBookingSpaceTier()

Grants an account tier access to a booking space by adding it to the space\'s allowed tiers list, requiring the update bookings permission and read access to tiers.

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let tierId: string; //The tier identifier (default to undefined)

const { status, data } = await apiInstance.addBookingSpaceTier(
    spaceId,
    tierId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **tierId** | [**string**] | The tier identifier | defaults to undefined|


### Return type

**CreateBookingSpace200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **cancelBooking**
> CreateBooking200Response cancelBooking()

Cancels an existing booking for a space, setting its status to canceled and triggering the booking cancellation side effect; requires the update bookings permission and only succeeds if the booking is currently ready or needs info.

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let bookingId: string; //The booking identifier (default to undefined)

const { status, data } = await apiInstance.cancelBooking(
    spaceId,
    bookingId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|


### Return type

**CreateBooking200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **checkInBooking**
> CreateBooking200Response checkInBooking()

Marks an existing booking as checked in by setting its checked-in timestamp, requires the update bookings permission, and fails if the booking is not in a ready or needs-info status or is already checked in.

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let bookingId: string; //The booking identifier (default to undefined)

const { status, data } = await apiInstance.checkInBooking(
    spaceId,
    bookingId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|


### Return type

**CreateBooking200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **createBooking**
> CreateBooking200Response createBooking(bookingCreateInputs)

Creates a new booking within the specified booking space on behalf of an account, using the provided booking details, and requires the create bookings permission.

### Example

```typescript
import {
    BookingsApi,
    Configuration,
    BookingCreateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let bookingCreateInputs: BookingCreateInputs; //

const { status, data } = await apiInstance.createBooking(
    spaceId,
    bookingCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **bookingCreateInputs** | **BookingCreateInputs**|  | |
| **spaceId** | [**string**] | The space identifier | defaults to undefined|


### Return type

**CreateBooking200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteBooking**
> CreateBooking200Response deleteBooking()

Permanently deletes an existing booking from a booking space and requires the delete bookings permission. The API returns the deleted booking (used to invalidate place-scoped lists when place-owned).

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let bookingId: string; //The booking identifier (default to undefined)

const { status, data } = await apiInstance.deleteBooking(
    spaceId,
    bookingId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|


### Return type

**CreateBooking200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBooking**
> CreateBooking200Response getBooking()

Retrieves the full details of a single booking by ID, including the place, space, and time slot it belongs to; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let bookingId: string; //The booking identifier (default to undefined)

const { status, data } = await apiInstance.getBooking(
    bookingId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|


### Return type

**CreateBooking200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingPlace**
> CreateBookingPlace200Response getBookingPlace()

Retrieves a single booking place (a bookable venue or location) by ID or slug, including its address and configuration; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let placeId: string; //The place identifier (default to undefined)

const { status, data } = await apiInstance.getBookingPlace(
    placeId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **placeId** | [**string**] | The place identifier | defaults to undefined|


### Return type

**CreateBookingPlace200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingPlaceBookings**
> GetAccountBookings200Response getBookingPlaceBookings()

Returns a paginated list of bookings made at a booking place, filterable by past/upcoming (`past`) and purchase status (`status`), and searchable by the booking account\'s name or email; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let placeId: string; //The place identifier (default to undefined)
let past: boolean; //Filter by past (optional) (default to undefined)
let status: PurchaseStatus; //Filter by status (optional) (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getBookingPlaceBookings(
    placeId,
    past,
    status,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **placeId** | [**string**] | The place identifier | defaults to undefined|
| **past** | [**boolean**] | Filter by past | (optional) defaults to undefined|
| **status** | **PurchaseStatus** | Filter by status | (optional) defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetAccountBookings200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingPlacePayments**
> GetAccountPayments200Response getBookingPlacePayments()

Returns a paginated list of payments made for bookings at a booking place, searchable by the paying account\'s name or email; requires the \"read\" permission on \"bookings\" and \"read\" permission on \"payments\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let placeId: string; //The place identifier (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getBookingPlacePayments(
    placeId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **placeId** | [**string**] | The place identifier | defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetAccountPayments200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingPlaceTranslation**
> GetBookingPlaceTranslation200Response getBookingPlaceTranslation()

Retrieves the translated name and description of a booking place in a specific locale, returning null if no translation exists for that locale; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let placeId: string; //The place identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.getBookingPlaceTranslation(
    placeId,
    locale
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **placeId** | [**string**] | The place identifier | defaults to undefined|
| **locale** | [**string**] | The locale identifier | defaults to undefined|


### Return type

**GetBookingPlaceTranslation200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingPlaceTranslations**
> GetBookingPlaceTranslations200Response getBookingPlaceTranslations()

Returns a paginated list of locale translations for a booking place, supporting search and ordering; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let placeId: string; //The place identifier (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getBookingPlaceTranslations(
    placeId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **placeId** | [**string**] | The place identifier | defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetBookingPlaceTranslations200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingPlaces**
> GetBookingPlaces200Response getBookingPlaces()

Returns a paginated list of an organization\'s booking places (bookable venues or locations), searchable by name, description, or address and sortable via orderBy; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getBookingPlaces(
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetBookingPlaces200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingResponses**
> GetBookingResponses200Response getBookingResponses()

Returns the answers an account submitted to a booking space\'s custom questions for a specific booking, ordered by question sort order; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let bookingId: string; //The booking identifier (default to undefined)

const { status, data } = await apiInstance.getBookingResponses(
    bookingId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|


### Return type

**GetBookingResponses200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingSpace**
> CreateBookingSpace200Response getBookingSpace()

Returns a single bookable space by its id or slug; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)

const { status, data } = await apiInstance.getBookingSpace(
    spaceId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|


### Return type

**CreateBookingSpace200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingSpaceAvailabilities**
> GetBookingSpaceAvailabilities200Response getBookingSpaceAvailabilities()

Returns the recurring weekly availability windows configured for a booking space, i.e. the days and times the space can be booked; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)

const { status, data } = await apiInstance.getBookingSpaceAvailabilities(
    spaceId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|


### Return type

**GetBookingSpaceAvailabilities200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingSpaceAvailability**
> CreateBookingSpaceAvailability200Response getBookingSpaceAvailability()

Returns a single availability window for a booking space by id; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let availabilityId: string; //The availability identifier (default to undefined)

const { status, data } = await apiInstance.getBookingSpaceAvailability(
    spaceId,
    availabilityId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **availabilityId** | [**string**] | The availability identifier | defaults to undefined|


### Return type

**CreateBookingSpaceAvailability200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingSpaceBlackout**
> CreateBookingSpaceBlackout200Response getBookingSpaceBlackout()

Returns a single blackout record for a booking space by id, i.e. a date/time range during which the space cannot be booked; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let blackoutId: string; //The blackout identifier (default to undefined)

const { status, data } = await apiInstance.getBookingSpaceBlackout(
    spaceId,
    blackoutId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **blackoutId** | [**string**] | The blackout identifier | defaults to undefined|


### Return type

**CreateBookingSpaceBlackout200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingSpaceBlackouts**
> GetBookingSpaceBlackouts200Response getBookingSpaceBlackouts()

Returns a paginated list of blackout date/time ranges during which a booking space cannot be booked, filterable by past/upcoming via the \"past\" parameter and by search text; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let past: boolean; //Filter by past (optional) (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getBookingSpaceBlackouts(
    spaceId,
    past,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **past** | [**boolean**] | Filter by past | (optional) defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetBookingSpaceBlackouts200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingSpaceBookings**
> GetAccountBookings200Response getBookingSpaceBookings()

Returns a paginated list of bookings made for a booking space, filterable by past/upcoming, purchase status, and search text against the account\'s name or email; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let past: boolean; //Filter by past (optional) (default to undefined)
let status: PurchaseStatus; //Filter by status (optional) (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getBookingSpaceBookings(
    spaceId,
    past,
    status,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **past** | [**boolean**] | Filter by past | (optional) defaults to undefined|
| **status** | **PurchaseStatus** | Filter by status | (optional) defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetAccountBookings200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingSpacePayments**
> GetAccountPayments200Response getBookingSpacePayments()

Returns a paginated list of payments made for bookings in a booking space, filterable by search text against the paying account\'s name or email; requires the \"read\" permission on \"bookings\" and \"payments\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let past: boolean; //Filter by past (optional) (default to undefined)
let status: PurchaseStatus; //Filter by status (optional) (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getBookingSpacePayments(
    spaceId,
    past,
    status,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **past** | [**boolean**] | Filter by past | (optional) defaults to undefined|
| **status** | **PurchaseStatus** | Filter by status | (optional) defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetAccountPayments200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingSpaceSlots**
> GetBookingSpaceSlots200Response getBookingSpaceSlots()

Returns the day-by-day list of bookable time slots for a booking space for the calendar month starting at firstDayOfMonth, requiring read permission on bookings.

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let firstDayOfMonth: string; //Filter by firstDayOfMonth (default to undefined)

const { status, data } = await apiInstance.getBookingSpaceSlots(
    spaceId,
    firstDayOfMonth
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **firstDayOfMonth** | [**string**] | Filter by firstDayOfMonth | defaults to undefined|


### Return type

**GetBookingSpaceSlots200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingSpaceTiers**
> GetAccountTiers200Response getBookingSpaceTiers()

Returns a paginated, searchable list of membership tiers assigned to a booking space, requiring read permission on bookings and tiers.

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getBookingSpaceTiers(
    spaceId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetAccountTiers200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingSpaceTranslation**
> GetBookingSpaceTranslation200Response getBookingSpaceTranslation()

Returns the localized name/description translation of a booking space for the given locale, or null if no translation exists, requiring read permission on bookings.

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.getBookingSpaceTranslation(
    spaceId,
    locale
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **locale** | [**string**] | The locale identifier | defaults to undefined|


### Return type

**GetBookingSpaceTranslation200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingSpaceTranslations**
> GetBookingSpaceTranslations200Response getBookingSpaceTranslations()

Returns a paginated, searchable list of locale translations for a booking space, requiring read permission on bookings.

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getBookingSpaceTranslations(
    spaceId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetBookingSpaceTranslations200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getBookingSpaces**
> GetBookingSpaces200Response getBookingSpaces()

Returns a paginated list of bookable spaces for the organization (no parent filter — includes spaces with no parents), or spaces linked to any combination of place, event, group, and/or account ids; supports search and ordering; requires the \"read\" permission on \"bookings\".

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let placeId: string; //Filter by placeId (optional) (default to undefined)
let eventId: string; //Filter by eventId (optional) (default to undefined)
let groupId: string; //Filter by groupId (optional) (default to undefined)
let accountId: string; //Filter by accountId (optional) (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getBookingSpaces(
    placeId,
    eventId,
    groupId,
    accountId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **placeId** | [**string**] | Filter by placeId | (optional) defaults to undefined|
| **eventId** | [**string**] | Filter by eventId | (optional) defaults to undefined|
| **groupId** | [**string**] | Filter by groupId | (optional) defaults to undefined|
| **accountId** | [**string**] | Filter by accountId | (optional) defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetBookingSpaces200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **removeBookingSpaceTier**
> CreateBookingSpace200Response removeBookingSpaceTier()

Revokes an account tier\'s access to a booking space by disconnecting it from the space\'s allowed tiers list, requiring the update bookings permission and read access to tiers.

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let tierId: string; //The tier identifier (default to undefined)

const { status, data } = await apiInstance.removeBookingSpaceTier(
    spaceId,
    tierId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **tierId** | [**string**] | The tier identifier | defaults to undefined|


### Return type

**CreateBookingSpace200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **undoCheckInBooking**
> CreateBooking200Response undoCheckInBooking()

Reverts a previous check-in on a booking by clearing its checked-in timestamp and requires the update bookings permission.

### Example

```typescript
import {
    BookingsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let bookingId: string; //The booking identifier (default to undefined)

const { status, data } = await apiInstance.undoCheckInBooking(
    spaceId,
    bookingId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|


### Return type

**CreateBooking200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **updateBooking**
> CreateBooking200Response updateBooking(bookingUpdateInputs)

Updates an existing booking for a bookable space, identified by spaceId and bookingId, requiring update permission on bookings.

### Example

```typescript
import {
    BookingsApi,
    Configuration,
    BookingUpdateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BookingsApi(configuration);

let spaceId: string; //The space identifier (default to undefined)
let bookingId: string; //The booking identifier (default to undefined)
let bookingUpdateInputs: BookingUpdateInputs; //

const { status, data } = await apiInstance.updateBooking(
    spaceId,
    bookingId,
    bookingUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **bookingUpdateInputs** | **BookingUpdateInputs**|  | |
| **spaceId** | [**string**] | The space identifier | defaults to undefined|
| **bookingId** | [**string**] | The booking identifier | defaults to undefined|


### Return type

**CreateBooking200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)