# EventsMediaApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addEventMediaItemPassType**](#addeventmediaitempasstype) | **POST** /events/{eventId}/media/{mediaItemId}/passTypes/{passTypeId} | Restrict an event media item to a pass type|
|[**addEventMediaItemTier**](#addeventmediaitemtier) | **POST** /events/{eventId}/media/{mediaItemId}/tiers/{tierId} | Restrict an event media item to a tier|
|[**createEventMediaItem**](#createeventmediaitem) | **POST** /events/{eventId}/media | Create an event media item|
|[**deleteEventMediaItem**](#deleteeventmediaitem) | **DELETE** /events/{eventId}/media/{mediaItemId} | Delete an event media item|
|[**getEventMediaItem**](#geteventmediaitem) | **GET** /events/{eventId}/media/{itemId} | Get a single event media item|
|[**getEventMediaItemActivities**](#geteventmediaitemactivities) | **GET** /events/{eventId}/media/{mediaItemId}/activities | List a media item\'s activity feed|
|[**getEventMediaItemLikes**](#geteventmediaitemlikes) | **GET** /events/{eventId}/media/{mediaItemId}/likes | List a media item\'s likes|
|[**getEventMediaItemPassTypes**](#geteventmediaitempasstypes) | **GET** /events/{eventId}/media/{mediaItemId}/passTypes | List pass types linked to a media item|
|[**getEventMediaItemTiers**](#geteventmediaitemtiers) | **GET** /events/{eventId}/media/{mediaItemId}/tiers | List tiers linked to a media item|
|[**getEventMediaItems**](#geteventmediaitems) | **GET** /events/{eventId}/media | List an event\'s media items|
|[**removeEventMediaItemPassType**](#removeeventmediaitempasstype) | **DELETE** /events/{eventId}/media/{mediaItemId}/passTypes/{passTypeId} | Remove a pass type restriction from an event media item|
|[**removeEventMediaItemTier**](#removeeventmediaitemtier) | **DELETE** /events/{eventId}/media/{mediaItemId}/tiers/{tierId} | Remove a tier restriction from an event media item|
|[**updateEventMediaItem**](#updateeventmediaitem) | **PUT** /events/{eventId}/media/{mediaItemId} | Update an event media item|

# **addEventMediaItemPassType**
> CreateEventMediaItem200Response addEventMediaItemPassType()

Grants a specific pass type access to an event media item, restricting who can view it, and requires read and update permission on both events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let mediaItemId: string; //The mediaItem identifier (default to undefined)
let passTypeId: string; //The passType identifier (default to undefined)

const { status, data } = await apiInstance.addEventMediaItemPassType(
    eventId,
    mediaItemId,
    passTypeId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|


### Return type

**CreateEventMediaItem200Response**

### 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)

# **addEventMediaItemTier**
> CreateEventMediaItem200Response addEventMediaItemTier()

Grants a specific account tier (tier/segment) access to an event media item, restricting who can view it, and requires read and update permission on both events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let mediaItemId: string; //The mediaItem identifier (default to undefined)
let tierId: string; //The tier identifier (default to undefined)

const { status, data } = await apiInstance.addEventMediaItemTier(
    eventId,
    mediaItemId,
    tierId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
| **tierId** | [**string**] | The tier identifier | defaults to undefined|


### Return type

**CreateEventMediaItem200Response**

### 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)

# **createEventMediaItem**
> CreateEventMediaItem200Response createEventMediaItem(eventMediaItemCreateInputs)

Creates a new media item (image, video, or file) in an event\'s media gallery, and requires read and update permission on both events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let eventMediaItemCreateInputs: EventMediaItemCreateInputs; //

const { status, data } = await apiInstance.createEventMediaItem(
    eventId,
    eventMediaItemCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventMediaItemCreateInputs** | **EventMediaItemCreateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|


### Return type

**CreateEventMediaItem200Response**

### 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)

# **deleteEventMediaItem**
> CreateAccountInvitations200Response deleteEventMediaItem()

Permanently removes a media item from an event\'s media gallery, and requires read and update permission on both events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let mediaItemId: string; //The mediaItem identifier (default to undefined)

const { status, data } = await apiInstance.deleteEventMediaItem(
    eventId,
    mediaItemId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|


### Return type

**CreateAccountInvitations200Response**

### 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)

# **getEventMediaItem**
> CreateEventMediaItem200Response getEventMediaItem()

Returns the details of a single media item (e.g. an image, video, or file) belonging to the given event; requires read access to events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let itemId: string; //The item identifier (default to undefined)

const { status, data } = await apiInstance.getEventMediaItem(
    eventId,
    itemId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **itemId** | [**string**] | The item identifier | defaults to undefined|


### Return type

**CreateEventMediaItem200Response**

### 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)

# **getEventMediaItemActivities**
> GetAccountActivities200Response getEventMediaItemActivities()

Returns a paginated list of activity records posted on a specific event media item, optionally filtered by activity status and search term, requiring read permission on events, storage, and activities.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let mediaItemId: string; //The mediaItem identifier (default to undefined)
let status: ActivityStatus; //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.getEventMediaItemActivities(
    eventId,
    mediaItemId,
    status,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
| **status** | **ActivityStatus** | 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

**GetAccountActivities200Response**

### 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)

# **getEventMediaItemLikes**
> GetEventMediaItemLikes200Response getEventMediaItemLikes()

Returns a paginated list of accounts that liked a specific event media item, optionally filtered by search term and sort order, requiring read permission on events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let mediaItemId: string; //The mediaItem 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.getEventMediaItemLikes(
    eventId,
    mediaItemId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **mediaItemId** | [**string**] | The mediaItem 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

**GetEventMediaItemLikes200Response**

### 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)

# **getEventMediaItemPassTypes**
> GetEventAddOnPassTypes200Response getEventMediaItemPassTypes()

Returns a paginated list of the event\'s pass types (ticket types) that are associated with a given media item, supporting search and ordering; requires read access to events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let mediaItemId: string; //The mediaItem 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.getEventMediaItemPassTypes(
    eventId,
    mediaItemId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **mediaItemId** | [**string**] | The mediaItem 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

**GetEventAddOnPassTypes200Response**

### 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)

# **getEventMediaItemTiers**
> GetAccountTiers200Response getEventMediaItemTiers()

Returns a paginated list of the event\'s account tiers (tiers/segments) that are associated with a given media item, supporting search and ordering; requires read access to events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let mediaItemId: string; //The mediaItem 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.getEventMediaItemTiers(
    eventId,
    mediaItemId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **mediaItemId** | [**string**] | The mediaItem 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)

# **getEventMediaItems**
> GetEventMediaItems200Response getEventMediaItems()

Returns a paginated list of media items (images, videos, or files) belonging to the given event, optionally filtered by media type, with search and ordering support; requires read access to events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let type: 'image' | 'video' | 'file'; //Filter by type (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.getEventMediaItems(
    eventId,
    type,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **type** | [**&#39;image&#39; | &#39;video&#39; | &#39;file&#39;**]**Array<&#39;image&#39; &#124; &#39;video&#39; &#124; &#39;file&#39;>** | Filter by type | (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

**GetEventMediaItems200Response**

### 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)

# **removeEventMediaItemPassType**
> CreateEventMediaItem200Response removeEventMediaItemPassType()

Revokes a pass type\'s access to an event media item, and requires read and update permission on both events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let mediaItemId: string; //The mediaItem identifier (default to undefined)
let passTypeId: string; //The passType identifier (default to undefined)

const { status, data } = await apiInstance.removeEventMediaItemPassType(
    eventId,
    mediaItemId,
    passTypeId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|


### Return type

**CreateEventMediaItem200Response**

### 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)

# **removeEventMediaItemTier**
> CreateEventMediaItem200Response removeEventMediaItemTier()

Revokes an account tier\'s (tier/segment) access to an event media item, and requires read and update permission on both events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let mediaItemId: string; //The mediaItem identifier (default to undefined)
let tierId: string; //The tier identifier (default to undefined)

const { status, data } = await apiInstance.removeEventMediaItemTier(
    eventId,
    mediaItemId,
    tierId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
| **tierId** | [**string**] | The tier identifier | defaults to undefined|


### Return type

**CreateEventMediaItem200Response**

### 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)

# **updateEventMediaItem**
> CreateEventMediaItem200Response updateEventMediaItem(eventMediaItemUpdateInputs)

Updates the fields (such as name, type, or file references) of an existing media item in an event\'s media gallery, and requires read and update permission on both events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let mediaItemId: string; //The mediaItem identifier (default to undefined)
let eventMediaItemUpdateInputs: EventMediaItemUpdateInputs; //

const { status, data } = await apiInstance.updateEventMediaItem(
    eventId,
    mediaItemId,
    eventMediaItemUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventMediaItemUpdateInputs** | **EventMediaItemUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|


### Return type

**CreateEventMediaItem200Response**

### 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)