# OrganizationTeammembersApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createOrganizationTeamMember**](#createorganizationteammember) | **POST** /organization/team-members | Create an organization team member|
|[**deleteOrganizationTeamMember**](#deleteorganizationteammember) | **DELETE** /organization/team-members/{teamMemberId} | Delete an organization team member|
|[**getOrganizationTeamMember**](#getorganizationteammember) | **GET** /organization/team-members/{teamMemberId} | Get an organization team member|
|[**getOrganizationTeamMembers**](#getorganizationteammembers) | **GET** /organization/team-members | List organization team members|
|[**updateOrganizationTeamMember**](#updateorganizationteammember) | **PUT** /organization/team-members/{teamMemberId} | Update an organization team member|

# **createOrganizationTeamMember**
> CreateOrganizationTeamMember200Response createOrganizationTeamMember(organizationTeamMemberCreateInputs)

Creates a new team member profile (staff shown on the organization\'s public team page) with fields such as name, title, and image, assigning it the next display priority; requires update permission on the organization.

### Example

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

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

let organizationTeamMemberCreateInputs: OrganizationTeamMemberCreateInputs; //

const { status, data } = await apiInstance.createOrganizationTeamMember(
    organizationTeamMemberCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **organizationTeamMemberCreateInputs** | **OrganizationTeamMemberCreateInputs**|  | |


### Return type

**CreateOrganizationTeamMember200Response**

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

# **deleteOrganizationTeamMember**
> CreateAccountInvitations200Response deleteOrganizationTeamMember()

Permanently removes the specified team member from the organization and re-sequences the display priority of the remaining team members; requires update permission on the organization.

### Example

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

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

let teamMemberId: string; //The teamMember identifier (default to undefined)

const { status, data } = await apiInstance.deleteOrganizationTeamMember(
    teamMemberId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **teamMemberId** | [**string**] | The teamMember 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)

# **getOrganizationTeamMember**
> SyncAccounts200Response getOrganizationTeamMember()

Returns a single organization team member by ID, requiring the \"read\" permission on \"org\".

### Example

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

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

let teamMemberId: string; //The teamMember identifier (default to undefined)

const { status, data } = await apiInstance.getOrganizationTeamMember(
    teamMemberId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **teamMemberId** | [**string**] | The teamMember 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)

# **getOrganizationTeamMembers**
> GetOrganizationTeamMembers200Response getOrganizationTeamMembers()

Returns a paginated list of the organization\'s internal team members, supporting page, pageSize, orderBy, and search, and requiring the \"read\" permission on \"org\".

### Example

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

const configuration = new Configuration();
const apiInstance = new OrganizationTeammembersApi(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.getOrganizationTeamMembers(
    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

**GetOrganizationTeamMembers200Response**

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

# **updateOrganizationTeamMember**
> CreateOrganizationTeamMember200Response updateOrganizationTeamMember(organizationTeamMemberUpdateInputs)

Updates the specified team member\'s details (name, title, image, etc.) and, if a new display priority is provided, re-sequences the priority of the other team members accordingly; requires update permission on the organization.

### Example

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

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

let teamMemberId: string; //The teamMember identifier (default to undefined)
let organizationTeamMemberUpdateInputs: OrganizationTeamMemberUpdateInputs; //

const { status, data } = await apiInstance.updateOrganizationTeamMember(
    teamMemberId,
    organizationTeamMemberUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **organizationTeamMemberUpdateInputs** | **OrganizationTeamMemberUpdateInputs**|  | |
| **teamMemberId** | [**string**] | The teamMember identifier | defaults to undefined|


### Return type

**CreateOrganizationTeamMember200Response**

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