# MeetingsParticipantsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createMeetingParticipant**](#createmeetingparticipant) | **POST** /meetings/{meetingId}/participants | Add a participant to a meeting|
|[**deleteMeetingParticipant**](#deletemeetingparticipant) | **DELETE** /meetings/{meetingId}/participants/{participantId} | Remove a participant from a meeting|
|[**getMeetingParticipant**](#getmeetingparticipant) | **GET** /meetings/{meetingId}/participants/{participantId} | Get a meeting participant|
|[**getMeetingParticipants**](#getmeetingparticipants) | **GET** /meetings/{meetingId}/participants | List a meeting\'s participants|
|[**regenerateMeetingParticipantToken**](#regeneratemeetingparticipanttoken) | **POST** /meetings/{meetingId}/participants/{participantId}/regenerate | Regenerate a participant\'s join token|
|[**updateMeetingParticipant**](#updatemeetingparticipant) | **PUT** /meetings/{meetingId}/participants/{participantId} | Update a meeting participant|

# **createMeetingParticipant**
> SyncAccounts200Response createMeetingParticipant(meetingParticipantCreateInputs)

Adds a participant to the given meeting, assigning a role preset based on the meeting type and requester\'s admin status, and returns the participant along with a join token; requires read and create permissions on meetings.

### Example

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

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

let meetingId: string; //The meeting identifier (default to undefined)
let meetingParticipantCreateInputs: MeetingParticipantCreateInputs; //

const { status, data } = await apiInstance.createMeetingParticipant(
    meetingId,
    meetingParticipantCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **meetingParticipantCreateInputs** | **MeetingParticipantCreateInputs**|  | |
| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|


### Return type

**SyncAccounts200Response**

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

# **deleteMeetingParticipant**
> CreateAccountInvitations200Response deleteMeetingParticipant()

Removes the participant identified by participantId from the given meeting, revoking their access, and requires both read and delete permissions on meetings.

### Example

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

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

let meetingId: string; //The meeting identifier (default to undefined)
let participantId: string; //The participant identifier (default to undefined)

const { status, data } = await apiInstance.deleteMeetingParticipant(
    meetingId,
    participantId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
| **participantId** | [**string**] | The participant 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)

# **getMeetingParticipant**
> GetMeetingParticipant200Response getMeetingParticipant()

Returns details for a single participant in a meeting, including their peer ID, display name, join/leave times, and linked account (if not a guest); requires \"read\" permission on meetings.

### Example

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

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

let meetingId: string; //The meeting identifier (default to undefined)
let participantId: string; //The participant identifier (default to undefined)

const { status, data } = await apiInstance.getMeetingParticipant(
    meetingId,
    participantId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
| **participantId** | [**string**] | The participant identifier | defaults to undefined|


### Return type

**GetMeetingParticipant200Response**

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

# **getMeetingParticipants**
> GetMeetingParticipants200Response getMeetingParticipants()

Returns a paginated list of participants for the given meeting, each enriched with the linked account when the participant is not a guest, supporting page and pageSize parameters; requires \"read\" permission on meetings.

### Example

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

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

let meetingId: string; //The meeting 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.getMeetingParticipants(
    meetingId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **meetingId** | [**string**] | The meeting 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

**GetMeetingParticipants200Response**

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

# **regenerateMeetingParticipantToken**
> SyncAccounts200Response regenerateMeetingParticipantToken()

Issues a new authentication token for the participant identified by participantId in the given meeting, invalidating their previous token, and requires both read and create permissions on meetings.

### Example

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

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

let meetingId: string; //The meeting identifier (default to undefined)
let participantId: string; //The participant identifier (default to undefined)

const { status, data } = await apiInstance.regenerateMeetingParticipantToken(
    meetingId,
    participantId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
| **participantId** | [**string**] | The participant identifier | defaults to undefined|


### Return type

**SyncAccounts200Response**

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

# **updateMeetingParticipant**
> GetMeetingParticipant200Response updateMeetingParticipant(meetingParticipantUpdateInputs)

Updates fields (such as name or role) on an existing participant of a meeting, requires the \"update\" permission on meetings, and refreshes the cached participant and participant list.

### Example

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

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

let meetingId: string; //The meeting identifier (default to undefined)
let participantId: string; //The participant identifier (default to undefined)
let meetingParticipantUpdateInputs: MeetingParticipantUpdateInputs; //

const { status, data } = await apiInstance.updateMeetingParticipant(
    meetingId,
    participantId,
    meetingParticipantUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **meetingParticipantUpdateInputs** | **MeetingParticipantUpdateInputs**|  | |
| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
| **participantId** | [**string**] | The participant identifier | defaults to undefined|


### Return type

**GetMeetingParticipant200Response**

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