# SurveysQuestionsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addSurveyQuestionChoiceSubQuestion**](#addsurveyquestionchoicesubquestion) | **POST** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Attach a follow-up sub-question to a choice|
|[**attachSurveyQuestionSearchList**](#attachsurveyquestionsearchlist) | **PUT** /surveys/{surveyId}/questions/{questionId}/searchlist | Attach a search list to a survey question|
|[**createSurveyQuestion**](#createsurveyquestion) | **POST** /surveys/{surveyId}/questions | Create a survey question|
|[**createSurveyQuestionChoice**](#createsurveyquestionchoice) | **POST** /surveys/{surveyId}/questions/{questionId}/choices | Create a choice for a survey question|
|[**deleteSurveyQuestion**](#deletesurveyquestion) | **DELETE** /surveys/{surveyId}/questions/{questionId} | Delete a survey question|
|[**deleteSurveyQuestionChoice**](#deletesurveyquestionchoice) | **DELETE** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId} | Delete a survey question choice|
|[**detachSurveyQuestionSearchList**](#detachsurveyquestionsearchlist) | **DELETE** /surveys/{surveyId}/questions/{questionId}/searchlist | Detach the search list from a survey question|
|[**getSurveyQuestion**](#getsurveyquestion) | **GET** /surveys/{surveyId}/questions/{questionId} | Get a survey question|
|[**getSurveyQuestionChoice**](#getsurveyquestionchoice) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId} | Get a survey question choice|
|[**getSurveyQuestionChoiceSubQuestions**](#getsurveyquestionchoicesubquestions) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions | List a choice\'s follow-up sub-questions|
|[**getSurveyQuestionChoices**](#getsurveyquestionchoices) | **GET** /surveys/{surveyId}/questions/{questionId}/choices | List a survey question\'s choices|
|[**getSurveyQuestionMatrixRows**](#getsurveyquestionmatrixrows) | **GET** /surveys/{surveyId}/questions/{questionId}/matrixRows | List a matrix question\'s rows|
|[**getSurveyQuestionResponses**](#getsurveyquestionresponses) | **GET** /surveys/{surveyId}/questions/{questionId}/responses | List responses to a survey question|
|[**getSurveyQuestions**](#getsurveyquestions) | **GET** /surveys/{surveyId}/questions | List a survey\'s questions|
|[**removeSurveyQuestionChoiceSubQuestion**](#removesurveyquestionchoicesubquestion) | **DELETE** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Remove a follow-up sub-question from a choice|
|[**reorderSurveyQuestionChoiceSubQuestions**](#reordersurveyquestionchoicesubquestions) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/reorder | Reorder a choice\'s follow-up sub-questions|
|[**reorderSurveyQuestionChoices**](#reordersurveyquestionchoices) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/reorder | Reorder a survey question\'s choices|
|[**reorderSurveyQuestionMatrixRows**](#reordersurveyquestionmatrixrows) | **PUT** /surveys/{surveyId}/questions/{questionId}/matrixRows/reorder | Reorder a matrix question\'s rows|
|[**updateSurveyQuestion**](#updatesurveyquestion) | **PUT** /surveys/{surveyId}/questions/{questionId} | Update a survey question|
|[**updateSurveyQuestionChoice**](#updatesurveyquestionchoice) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId} | Update a survey question choice|
|[**updateSurveyQuestionChoiceSubQuestion**](#updatesurveyquestionchoicesubquestion) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Reorder a choice\'s sub-question|

# **addSurveyQuestionChoiceSubQuestion**
> CreateSurveyQuestionChoice200Response addSurveyQuestionChoiceSubQuestion()

Links an existing survey question as a sub-question of the given answer choice so it is presented as a follow-up when that choice is selected, requiring update permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let choiceId: string; //The choice identifier (default to undefined)
let subQuestionId: string; //The subQuestion identifier (default to undefined)

const { status, data } = await apiInstance.addSurveyQuestionChoiceSubQuestion(
    surveyId,
    questionId,
    choiceId,
    subQuestionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
| **choiceId** | [**string**] | The choice identifier | defaults to undefined|
| **subQuestionId** | [**string**] | The subQuestion identifier | defaults to undefined|


### Return type

**CreateSurveyQuestionChoice200Response**

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

# **attachSurveyQuestionSearchList**
> CreateSurveyQuestion200Response attachSurveyQuestionSearchList(attachSearchListInputs)

Sets the given search list as the source of selectable options for the specified survey question, verifying the search list belongs to the organization and requiring update permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let attachSearchListInputs: AttachSearchListInputs; //

const { status, data } = await apiInstance.attachSurveyQuestionSearchList(
    surveyId,
    questionId,
    attachSearchListInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **attachSearchListInputs** | **AttachSearchListInputs**|  | |
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**CreateSurveyQuestion200Response**

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

# **createSurveyQuestion**
> CreateSurveyQuestion200Response createSurveyQuestion(surveyQuestionCreateInputs)

Creates a new question on the given survey, optionally placing it in a section or as a sub-question of another question\'s choice and inserting it at a given sort order, requiring update permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let surveyQuestionCreateInputs: SurveyQuestionCreateInputs; //

const { status, data } = await apiInstance.createSurveyQuestion(
    surveyId,
    surveyQuestionCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyQuestionCreateInputs** | **SurveyQuestionCreateInputs**|  | |
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|


### Return type

**CreateSurveyQuestion200Response**

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

# **createSurveyQuestionChoice**
> CreateSurveyQuestionChoice200Response createSurveyQuestionChoice(surveyQuestionChoiceCreateInputs)

Creates a new selectable answer choice for the given survey question, inserting it at the requested sort order among existing choices and requiring update permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let surveyQuestionChoiceCreateInputs: SurveyQuestionChoiceCreateInputs; //

const { status, data } = await apiInstance.createSurveyQuestionChoice(
    surveyId,
    questionId,
    surveyQuestionChoiceCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyQuestionChoiceCreateInputs** | **SurveyQuestionChoiceCreateInputs**|  | |
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**CreateSurveyQuestionChoice200Response**

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

# **deleteSurveyQuestion**
> CreateAccountInvitations200Response deleteSurveyQuestion()

Permanently deletes the given question from the survey and re-sorts the remaining questions to fill the gap, requiring update permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let sectionId: string; //Filter by sectionId (optional) (default to undefined)

const { status, data } = await apiInstance.deleteSurveyQuestion(
    surveyId,
    questionId,
    sectionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
| **sectionId** | [**string**] | Filter by sectionId | (optional) 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)

# **deleteSurveyQuestionChoice**
> CreateAccountInvitations200Response deleteSurveyQuestionChoice()

Permanently deletes the given answer choice from a survey question and re-sorts the remaining choices, rejecting the deletion if the question is a checkbox type that already has responses, and requiring update permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let choiceId: string; //The choice identifier (default to undefined)

const { status, data } = await apiInstance.deleteSurveyQuestionChoice(
    surveyId,
    questionId,
    choiceId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
| **choiceId** | [**string**] | The choice 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)

# **detachSurveyQuestionSearchList**
> CreateSurveyQuestion200Response detachSurveyQuestionSearchList()

Removes the search list association from the given survey question, clearing its search-list-driven option source, and requires update permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)

const { status, data } = await apiInstance.detachSurveyQuestionSearchList(
    surveyId,
    questionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**CreateSurveyQuestion200Response**

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

# **getSurveyQuestion**
> CreateSurveyQuestion200Response getSurveyQuestion()

Returns the details of a single question on a survey, identified by survey and question ID; requires read access to the surveys module.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)

const { status, data } = await apiInstance.getSurveyQuestion(
    surveyId,
    questionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**CreateSurveyQuestion200Response**

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

# **getSurveyQuestionChoice**
> CreateSurveyQuestionChoice200Response getSurveyQuestionChoice()

Returns the details of a single answer choice belonging to a survey question, identified by survey, question, and choice ID; requires read access to the surveys module.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let choiceId: string; //The choice identifier (default to undefined)

const { status, data } = await apiInstance.getSurveyQuestionChoice(
    surveyId,
    questionId,
    choiceId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
| **choiceId** | [**string**] | The choice identifier | defaults to undefined|


### Return type

**CreateSurveyQuestionChoice200Response**

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

# **getSurveyQuestionChoiceSubQuestions**
> GetSurveyQuestionChoiceSubQuestions200Response getSurveyQuestionChoiceSubQuestions()

Returns a paginated list of the conditional sub-questions that are triggered when a given survey question choice is selected, supporting search by sub-question name or label; requires read access to the surveys module.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let choiceId: string; //The choice 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.getSurveyQuestionChoiceSubQuestions(
    surveyId,
    questionId,
    choiceId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
| **choiceId** | [**string**] | The choice 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

**GetSurveyQuestionChoiceSubQuestions200Response**

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

# **getSurveyQuestionChoices**
> GetSurveyQuestionChoices200Response getSurveyQuestionChoices()

Returns a paginated list of the answer choices defined for a survey question, ordered by sort order and supporting search by choice value; requires read access to the surveys module.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question 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.getSurveyQuestionChoices(
    surveyId,
    questionId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question 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

**GetSurveyQuestionChoices200Response**

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

# **getSurveyQuestionMatrixRows**
> GetSurveyQuestions200Response getSurveyQuestionMatrixRows()

Returns a paginated list of the row questions that belong to a matrix survey question, ordered by their matrix sort order and supporting search by row name, label, or description; requires read access to the surveys module.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question 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.getSurveyQuestionMatrixRows(
    surveyId,
    questionId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question 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

**GetSurveyQuestions200Response**

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

# **getSurveyQuestionResponses**
> GetSurveyQuestionResponses200Response getSurveyQuestionResponses()

Returns a paginated list of submitted responses for a survey question from completed submissions, supporting search by respondent name or email; file-upload responses include a temporary signed download URL, and read access to the surveys module is required.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question 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.getSurveyQuestionResponses(
    surveyId,
    questionId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question 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

**GetSurveyQuestionResponses200Response**

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

# **getSurveyQuestions**
> GetSurveyQuestions200Response getSurveyQuestions()

Returns a paginated list of all questions defined on a survey, ordered by sort order and supporting search by name, label, or description; requires read access to the surveys module.

### Example

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

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

let surveyId: string; //The survey 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.getSurveyQuestions(
    surveyId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

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

**GetSurveyQuestions200Response**

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

# **removeSurveyQuestionChoiceSubQuestion**
> CreateAccountInvitations200Response removeSurveyQuestionChoiceSubQuestion()

Unlinks a sub-question from the given answer choice so it is no longer shown as a follow-up when that choice is selected, re-sorting the remaining sub-questions, and requires update permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let choiceId: string; //The choice identifier (default to undefined)
let subQuestionId: string; //The subQuestion identifier (default to undefined)

const { status, data } = await apiInstance.removeSurveyQuestionChoiceSubQuestion(
    surveyId,
    questionId,
    choiceId,
    subQuestionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
| **choiceId** | [**string**] | The choice identifier | defaults to undefined|
| **subQuestionId** | [**string**] | The subQuestion 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)

# **reorderSurveyQuestionChoiceSubQuestions**
> ReorderSurveyQuestionChoiceSubQuestions200Response reorderSurveyQuestionChoiceSubQuestions(reorderEventFaqSectionQuestionsRequest)

Sets the display order of the follow-up sub-questions attached to a survey question choice to match the given full list of question IDs, rejecting the request if any sub-question is missing or unknown, and requires update permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let choiceId: string; //The choice identifier (default to undefined)
let reorderEventFaqSectionQuestionsRequest: ReorderEventFaqSectionQuestionsRequest; //

const { status, data } = await apiInstance.reorderSurveyQuestionChoiceSubQuestions(
    surveyId,
    questionId,
    choiceId,
    reorderEventFaqSectionQuestionsRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **reorderEventFaqSectionQuestionsRequest** | **ReorderEventFaqSectionQuestionsRequest**|  | |
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
| **choiceId** | [**string**] | The choice identifier | defaults to undefined|


### Return type

**ReorderSurveyQuestionChoiceSubQuestions200Response**

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

# **reorderSurveyQuestionChoices**
> ReorderSurveyQuestionChoices200Response reorderSurveyQuestionChoices(reorderBookingSpaceQuestionChoicesRequest)

Sets the display order of a survey question\'s answer choices to match the given full list of choice IDs, rejecting the request if any choice is missing or unknown, and requires update permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest; //

const { status, data } = await apiInstance.reorderSurveyQuestionChoices(
    surveyId,
    questionId,
    reorderBookingSpaceQuestionChoicesRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **reorderBookingSpaceQuestionChoicesRequest** | **ReorderBookingSpaceQuestionChoicesRequest**|  | |
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**ReorderSurveyQuestionChoices200Response**

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

# **reorderSurveyQuestionMatrixRows**
> ReorderSurveyQuestionMatrixRows200Response reorderSurveyQuestionMatrixRows(reorderSurveyQuestionMatrixRowsRequest)

Sets the display order of the rows belonging to a matrix survey question to match the given full list of row IDs, rejecting the request if any row is missing or unknown, and requires update permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest; //

const { status, data } = await apiInstance.reorderSurveyQuestionMatrixRows(
    surveyId,
    questionId,
    reorderSurveyQuestionMatrixRowsRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **reorderSurveyQuestionMatrixRowsRequest** | **ReorderSurveyQuestionMatrixRowsRequest**|  | |
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**ReorderSurveyQuestionMatrixRows200Response**

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

# **updateSurveyQuestion**
> CreateSurveyQuestion200Response updateSurveyQuestion(surveyQuestionUpdateInputs)

Updates a question\'s fields (such as name, description, type, or required flag) on the given survey, and reorders it among the survey\'s other questions when a new sortOrder is provided; requires the update surveys permission.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let surveyQuestionUpdateInputs: SurveyQuestionUpdateInputs; //

const { status, data } = await apiInstance.updateSurveyQuestion(
    surveyId,
    questionId,
    surveyQuestionUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyQuestionUpdateInputs** | **SurveyQuestionUpdateInputs**|  | |
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**CreateSurveyQuestion200Response**

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

# **updateSurveyQuestionChoice**
> SyncAccounts200Response updateSurveyQuestionChoice(surveyQuestionChoiceUpdateInputs)

Updates a choice (such as its label or value) belonging to a survey question, and reorders it among the question\'s other choices when a new sortOrder is provided; requires the update surveys permission.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let choiceId: string; //The choice identifier (default to undefined)
let surveyQuestionChoiceUpdateInputs: SurveyQuestionChoiceUpdateInputs; //

const { status, data } = await apiInstance.updateSurveyQuestionChoice(
    surveyId,
    questionId,
    choiceId,
    surveyQuestionChoiceUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyQuestionChoiceUpdateInputs** | **SurveyQuestionChoiceUpdateInputs**|  | |
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
| **choiceId** | [**string**] | The choice 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)

# **updateSurveyQuestionChoiceSubQuestion**
> CreateSurveyQuestionChoice200Response updateSurveyQuestionChoiceSubQuestion(updateEventFollowupQuestionRequest)

Changes the sort order of a sub-question linked to a survey question choice, shifting the other sub-questions attached to that choice to keep ordering consistent; requires the update surveys permission.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let choiceId: string; //The choice identifier (default to undefined)
let subQuestionId: string; //The subQuestion identifier (default to undefined)
let updateEventFollowupQuestionRequest: UpdateEventFollowupQuestionRequest; //

const { status, data } = await apiInstance.updateSurveyQuestionChoiceSubQuestion(
    surveyId,
    questionId,
    choiceId,
    subQuestionId,
    updateEventFollowupQuestionRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **updateEventFollowupQuestionRequest** | **UpdateEventFollowupQuestionRequest**|  | |
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
| **choiceId** | [**string**] | The choice identifier | defaults to undefined|
| **subQuestionId** | [**string**] | The subQuestion identifier | defaults to undefined|


### Return type

**CreateSurveyQuestionChoice200Response**

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