---
# System prepended metadata

title: Surveys

---

# Surveys

> query(`searchSurveys`) {
    
    organizationId: string,
    args: { 
        limit: number; 
        page: number; 
        searchTerm?: string;
    }
} => Pagination<SurveyResponse[]>

> mutation(`createSurvey`) {
    
    organizationId: string,
    input: {
        defaultLocaleCode: string;
        localeCodes: string[]>;
        name: string;
        type: string;
    }
} => SurveyResponse

> mutation(`updateSurvey`) {
  horizontalImage?: Upload;
  input: UpdateSurveyInput;
  organizationId: string;
  surveyId: string;
  verticalImage?: Upload;
} => SurveyResponse


> mutation(`trashSurvey`) {
    organizationId: string,
    surveyId: string
} => {message, success}

## Survey

> query(`survey`) {

    args: {
      organizationId: string;
      surveyId: string;
      withLocaleCodes?: string[];
    }
} => SurveyWithLocalesResponse

> mutation(`updateSurveyLocale`) { (for intro)
  input: UpdateSurveyLocaleInput;
  organizationId: string;
  surveyId: string;
} => SurveyWithLocalesResponse

> query(`surveyCompetencies`) { (for Competencies and items)
  localeCodes: string[];
  organizationId: string;
  surveyId: string;
} => SurveyCompetencyWithItemsResponse[]

### Survey Competency Group (for clone Group - paginate competency group)

> query(`searchCompetencyGroupsWithAllCompetencies`) {

    args: {
      limit: number;
      organizationId: string;
      page: number;
      searchTerm?: string;
    },
    localeCode?: string
} => Pagination<CompetencyGroupWithChildrenResponse[]>

#### Survey Competency (to copy group to survey)

> mutation(`cloneCompetenciesToSurvey`) {
    organizationId: string,
    surveyId: string,
    clonedCompetencies: {  
      order: string;
      originalCompetencyId: string
    }[]
} => {message, success}

> mutation(`updateSurveyCompetencyLocale`) {
    args: {
        input: UpdateSurveyCompetencyLocaleInput;
        localeCodes: string[];
        organizationId: string;
        surveyId: string;
    }
} => SurveyCompetencyResponse

> mutation(`deleteSurveyCompetency`) {
    _id: string,
    organizationId: string,
    surveyId: string
} => {message, success}

##### Survey Competency Item

> mutation(`updateSurveyCompetencyItem`) {
  input: UpdateSurveyCompetencyItemInput;
  organizationId: string;
  surveyId: string;
  withLocaleCodes: string[];
} => CompetencyItemResponse

> mutation(`updateSurveyCompetencyItemOrder`) {
    organizationId: string,
    surveyId: string,
    input: {_id: string; order: string;}
} => CompetencyItemResponse

##### Survey Competency sub item

> mutation(`updateSurveyCompetencyItemResponseLogic`) {
  input: UpdateSurveyCompetencyItemResponseLogicSubItemInput; (questionTitle and so on)
  organizationId: string;
  surveyId: string;
  withLocaleCodes: string[];
} => CompetencySubItemResponse