# SearchlistsValuesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**bulkUploadSearchListValues**](#bulkuploadsearchlistvalues) | **POST** /searchlists/{searchListId}/values/bulk | Bulk upload values to a search list|
|[**createSearchListValue**](#createsearchlistvalue) | **POST** /searchlists/{searchListId}/values | Create a search list value|
|[**deleteSearchListValue**](#deletesearchlistvalue) | **DELETE** /searchlists/{searchListId}/values/{valueId} | Delete a search list value|
|[**getSearchListConnectedQuestions**](#getsearchlistconnectedquestions) | **GET** /searchlists/{searchListId}/questions | List questions connected to a search list|
|[**getSearchListValue**](#getsearchlistvalue) | **GET** /searchlists/{searchListId}/values/{valueId} | Get a search list value|
|[**getSearchListValues**](#getsearchlistvalues) | **GET** /searchlists/{searchListId}/values | List a search list\'s values|
|[**updateSearchListValue**](#updatesearchlistvalue) | **PUT** /searchlists/{searchListId}/values/{valueId} | Update a search list value|

# **bulkUploadSearchListValues**
> BulkUploadSearchListValues200Response bulkUploadSearchListValues(bulkUploadSearchListValuesRequest)

Creates many values on the given search list in a single request from an array of strings, skipping duplicates, and requires organization read and update permissions.

### Example

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

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

let searchListId: string; //The searchList identifier (default to undefined)
let bulkUploadSearchListValuesRequest: BulkUploadSearchListValuesRequest; //

const { status, data } = await apiInstance.bulkUploadSearchListValues(
    searchListId,
    bulkUploadSearchListValuesRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **bulkUploadSearchListValuesRequest** | **BulkUploadSearchListValuesRequest**|  | |
| **searchListId** | [**string**] | The searchList identifier | defaults to undefined|


### Return type

**BulkUploadSearchListValues200Response**

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

# **createSearchListValue**
> CreateSearchListValue200Response createSearchListValue(searchListValueCreateInputs)

Adds a new value to the specified search list, rejecting duplicate values within the same list, and requires organization read and update permissions.

### Example

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

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

let searchListId: string; //The searchList identifier (default to undefined)
let searchListValueCreateInputs: SearchListValueCreateInputs; //

const { status, data } = await apiInstance.createSearchListValue(
    searchListId,
    searchListValueCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **searchListValueCreateInputs** | **SearchListValueCreateInputs**|  | |
| **searchListId** | [**string**] | The searchList identifier | defaults to undefined|


### Return type

**CreateSearchListValue200Response**

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

# **deleteSearchListValue**
> CreateAccountInvitations200Response deleteSearchListValue()

Permanently removes a single value from the specified search list and requires organization read and update permissions.

### Example

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

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

let searchListId: string; //The searchList identifier (default to undefined)
let valueId: string; //The value identifier (default to undefined)

const { status, data } = await apiInstance.deleteSearchListValue(
    searchListId,
    valueId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **searchListId** | [**string**] | The searchList identifier | defaults to undefined|
| **valueId** | [**string**] | The value 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)

# **getSearchListConnectedQuestions**
> GetSearchListConnectedQuestions200Response getSearchListConnectedQuestions()

Returns a cursor-paginated list of the questions that reference the given search list, with optional page size, ordering, and search term filters; requires the `read:org` permission.

### Example

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

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

let searchListId: string; //The searchList identifier (default to undefined)

const { status, data } = await apiInstance.getSearchListConnectedQuestions(
    searchListId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **searchListId** | [**string**] | The searchList identifier | defaults to undefined|


### Return type

**GetSearchListConnectedQuestions200Response**

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

# **getSearchListValue**
> CreateSearchListValue200Response getSearchListValue()

Returns a single value entry from a search list, identified by the search list ID and value ID; accessible to any authenticated admin user.

### Example

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

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

let searchListId: string; //The searchList identifier (default to undefined)
let valueId: string; //The value identifier (default to undefined)

const { status, data } = await apiInstance.getSearchListValue(
    searchListId,
    valueId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **searchListId** | [**string**] | The searchList identifier | defaults to undefined|
| **valueId** | [**string**] | The value identifier | defaults to undefined|


### Return type

**CreateSearchListValue200Response**

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

# **getSearchListValues**
> GetSearchListValues200Response getSearchListValues()

Returns a paginated, searchable list of the value entries belonging to the given search list, with optional page size, ordering, and search term filters; accessible to any authenticated admin user.

### Example

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

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

let searchListId: string; //The searchList 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.getSearchListValues(
    searchListId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

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

**GetSearchListValues200Response**

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

# **updateSearchListValue**
> CreateSearchListValue200Response updateSearchListValue(searchListValueUpdateInputs)

Updates the fields, such as the value text or priority, of an existing value on the specified search list and requires organization read and update permissions.

### Example

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

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

let searchListId: string; //The searchList identifier (default to undefined)
let valueId: string; //The value identifier (default to undefined)
let searchListValueUpdateInputs: SearchListValueUpdateInputs; //

const { status, data } = await apiInstance.updateSearchListValue(
    searchListId,
    valueId,
    searchListValueUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **searchListValueUpdateInputs** | **SearchListValueUpdateInputs**|  | |
| **searchListId** | [**string**] | The searchList identifier | defaults to undefined|
| **valueId** | [**string**] | The value identifier | defaults to undefined|


### Return type

**CreateSearchListValue200Response**

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