> For the complete documentation index, see [llms.txt](https://api-docs.myhappyforce.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.myhappyforce.com/docs/api-reference/advisors-survey-resource.md).

# Advisors Survey Resource

## GET /api/v1/company/advisor/surveys/templates/{templateId}

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"SurveyTemplateDTO":{"type":"object","properties":{"id":{"type":"string"},"categoryId":{"type":"string"},"active":{"type":"boolean"},"restrictedToCompanies":{"type":"array","items":{"type":"string"},"uniqueItems":true},"restrictedToIndustries":{"type":"array","items":{"type":"string","enum":["ACCOMMODATION_AND_FOOT_SERVICES","ARTS_ENTERTAINMENT_RECREATION","COMPUTER_SOFTWARE_IT_SERVICES","CONSTRUCTION","EDUCATIONAL_SERVICES","FINANCIAL_SERVICES_INSURANCE","HEALTH_CARE_SOCIAL_ASSISTANCE","MANAGEMENT_CONSULTING","MANUFACTURING","MARKETING_ADVERTISING","NATURAL_RESOURCES","NON_PROFIT_ORGANIZATION","PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES","PUBLIC_AND_GOVERMENT_ADMINISTRATION","REAL_ESTATE_RENTAL_AND_LEASING","TRANSPORTATION_AND_WAREHOUSING","UTILITIES_AND_SERVICES","WHOLESALE_AND_RETAIL_TRADE","OTHER"]},"uniqueItems":true},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"catalogTitle":{"$ref":"#/components/schemas/MultiLanguage"},"catalogDescription":{"$ref":"#/components/schemas/MultiLanguage"},"imagePath":{"type":"string"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/SurveyBlock"}},"usedIn":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]},"SurveyBlock":{"type":"object","properties":{"id":{"type":"string"},"order":{"type":"integer","format":"int32"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]},"minItems":1}},"required":["questions","title"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]}}},"paths":{"/api/v1/company/advisor/surveys/templates/{templateId}":{"get":{"tags":["advisors-survey-resource"],"operationId":"getSurveyTemplate","parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SurveyTemplateDTO"}}}}}}}}}
```

## PUT /api/v1/company/advisor/surveys/templates/{templateId}

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"SurveyTemplateDTO":{"type":"object","properties":{"id":{"type":"string"},"categoryId":{"type":"string"},"active":{"type":"boolean"},"restrictedToCompanies":{"type":"array","items":{"type":"string"},"uniqueItems":true},"restrictedToIndustries":{"type":"array","items":{"type":"string","enum":["ACCOMMODATION_AND_FOOT_SERVICES","ARTS_ENTERTAINMENT_RECREATION","COMPUTER_SOFTWARE_IT_SERVICES","CONSTRUCTION","EDUCATIONAL_SERVICES","FINANCIAL_SERVICES_INSURANCE","HEALTH_CARE_SOCIAL_ASSISTANCE","MANAGEMENT_CONSULTING","MANUFACTURING","MARKETING_ADVERTISING","NATURAL_RESOURCES","NON_PROFIT_ORGANIZATION","PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES","PUBLIC_AND_GOVERMENT_ADMINISTRATION","REAL_ESTATE_RENTAL_AND_LEASING","TRANSPORTATION_AND_WAREHOUSING","UTILITIES_AND_SERVICES","WHOLESALE_AND_RETAIL_TRADE","OTHER"]},"uniqueItems":true},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"catalogTitle":{"$ref":"#/components/schemas/MultiLanguage"},"catalogDescription":{"$ref":"#/components/schemas/MultiLanguage"},"imagePath":{"type":"string"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/SurveyBlock"}},"usedIn":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]},"SurveyBlock":{"type":"object","properties":{"id":{"type":"string"},"order":{"type":"integer","format":"int32"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]},"minItems":1}},"required":["questions","title"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]}}},"paths":{"/api/v1/company/advisor/surveys/templates/{templateId}":{"put":{"tags":["advisors-survey-resource"],"operationId":"updateSurveyTemplates","parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SurveyTemplateDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SurveyTemplateDTO"}}}}}}}}}
```

## DELETE /api/v1/company/advisor/surveys/templates/{templateId}

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"SurveyTemplateCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"color":{"type":"string"},"iconPath":{"type":"string"}}},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]}}},"paths":{"/api/v1/company/advisor/surveys/templates/{templateId}":{"delete":{"tags":["advisors-survey-resource"],"operationId":"deleteSurveyTemplate","parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SurveyTemplateCategoryDTO"}}}}}}}}}
```

## PUT /api/v1/company/advisor/surveys/categories/{categoryId}

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"SurveyTemplateCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"color":{"type":"string"},"iconPath":{"type":"string"}}},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]}}},"paths":{"/api/v1/company/advisor/surveys/categories/{categoryId}":{"put":{"tags":["advisors-survey-resource"],"operationId":"updateSurveyCategoryTemplates","parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SurveyTemplateCategoryDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SurveyTemplateCategoryDTO"}}}}}}}}}
```

## DELETE /api/v1/company/advisor/surveys/categories/{categoryId}

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"SurveyTemplateCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"color":{"type":"string"},"iconPath":{"type":"string"}}},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]}}},"paths":{"/api/v1/company/advisor/surveys/categories/{categoryId}":{"delete":{"tags":["advisors-survey-resource"],"operationId":"deleteSurveyCategoryTemplates","parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SurveyTemplateCategoryDTO"}}}}}}}}}
```

## GET /api/v1/company/advisor/surveys/templates

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"SurveyTemplateDTO":{"type":"object","properties":{"id":{"type":"string"},"categoryId":{"type":"string"},"active":{"type":"boolean"},"restrictedToCompanies":{"type":"array","items":{"type":"string"},"uniqueItems":true},"restrictedToIndustries":{"type":"array","items":{"type":"string","enum":["ACCOMMODATION_AND_FOOT_SERVICES","ARTS_ENTERTAINMENT_RECREATION","COMPUTER_SOFTWARE_IT_SERVICES","CONSTRUCTION","EDUCATIONAL_SERVICES","FINANCIAL_SERVICES_INSURANCE","HEALTH_CARE_SOCIAL_ASSISTANCE","MANAGEMENT_CONSULTING","MANUFACTURING","MARKETING_ADVERTISING","NATURAL_RESOURCES","NON_PROFIT_ORGANIZATION","PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES","PUBLIC_AND_GOVERMENT_ADMINISTRATION","REAL_ESTATE_RENTAL_AND_LEASING","TRANSPORTATION_AND_WAREHOUSING","UTILITIES_AND_SERVICES","WHOLESALE_AND_RETAIL_TRADE","OTHER"]},"uniqueItems":true},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"catalogTitle":{"$ref":"#/components/schemas/MultiLanguage"},"catalogDescription":{"$ref":"#/components/schemas/MultiLanguage"},"imagePath":{"type":"string"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/SurveyBlock"}},"usedIn":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]},"SurveyBlock":{"type":"object","properties":{"id":{"type":"string"},"order":{"type":"integer","format":"int32"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]},"minItems":1}},"required":["questions","title"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]}}},"paths":{"/api/v1/company/advisor/surveys/templates":{"get":{"tags":["advisors-survey-resource"],"operationId":"getSurveyTemplates","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SurveyTemplateDTO"}}}}}}}}}}
```

## POST /api/v1/company/advisor/surveys/templates

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"SurveyTemplateDTO":{"type":"object","properties":{"id":{"type":"string"},"categoryId":{"type":"string"},"active":{"type":"boolean"},"restrictedToCompanies":{"type":"array","items":{"type":"string"},"uniqueItems":true},"restrictedToIndustries":{"type":"array","items":{"type":"string","enum":["ACCOMMODATION_AND_FOOT_SERVICES","ARTS_ENTERTAINMENT_RECREATION","COMPUTER_SOFTWARE_IT_SERVICES","CONSTRUCTION","EDUCATIONAL_SERVICES","FINANCIAL_SERVICES_INSURANCE","HEALTH_CARE_SOCIAL_ASSISTANCE","MANAGEMENT_CONSULTING","MANUFACTURING","MARKETING_ADVERTISING","NATURAL_RESOURCES","NON_PROFIT_ORGANIZATION","PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES","PUBLIC_AND_GOVERMENT_ADMINISTRATION","REAL_ESTATE_RENTAL_AND_LEASING","TRANSPORTATION_AND_WAREHOUSING","UTILITIES_AND_SERVICES","WHOLESALE_AND_RETAIL_TRADE","OTHER"]},"uniqueItems":true},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"catalogTitle":{"$ref":"#/components/schemas/MultiLanguage"},"catalogDescription":{"$ref":"#/components/schemas/MultiLanguage"},"imagePath":{"type":"string"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/SurveyBlock"}},"usedIn":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]},"SurveyBlock":{"type":"object","properties":{"id":{"type":"string"},"order":{"type":"integer","format":"int32"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OpenSurveyQuestion"},{"$ref":"#/components/schemas/OptionsSurveyQuestion"},{"$ref":"#/components/schemas/ScaleSurveyQuestion"}]},"minItems":1}},"required":["questions","title"]},"OpenSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"requireNotEmpty":{"type":"boolean"}}}],"required":["questionType","representation","title","voteMode"]},"AbstractSurveyQuestion":{"type":"object","description":"Base class for survey questions","discriminator":{"propertyName":"questionType","mapping":{"OPEN":"#/components/schemas/OpenSurveyQuestion","TOPIC":"#/components/schemas/OptionsSurveyQuestion","RANGE":"#/components/schemas/ScaleSurveyQuestion"}},"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"questionType":{"$ref":"#/components/schemas/QuestionType"},"order":{"type":"integer","format":"int32"},"visible":{"type":"boolean"},"computeInBlock":{"type":"boolean"},"feedbackEnabled":{"type":"boolean"},"mandatory":{"type":"boolean","deprecated":true},"voteMode":{"$ref":"#/components/schemas/QuestionVoteMode"},"representation":{"type":"string","enum":["IMAGES","OPTIONS","MULTIPLE_OPTIONS","FEEDBACK","SCALE","GRADIENT_SLIDE"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"uniqueItems":true}},"required":["questionType","representation","title","voteMode"]},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionVoteMode":{"type":"string","description":"Modes of question voting in a survey or feedback form. Defines whether a question is mandatory, optional, or deferred.","enum":["MANDATORY","OPTIONAL","DEFERRED"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]},"OptionsSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"},"maxItems":2147483647,"minItems":2,"uniqueItems":true},"minSelection":{"type":"integer","format":"int32"},"maxSelection":{"type":"integer","format":"int32"},"multipleChoice":{"type":"boolean"},"minValue":{"$ref":"#/components/schemas/QuestionValue"},"maxValue":{"$ref":"#/components/schemas/QuestionValue"}}}],"required":["questionType","representation","title","voteMode"]},"ScaleSurveyQuestion":{"allOf":[{"$ref":"#/components/schemas/AbstractSurveyQuestion"},{"type":"object","properties":{"firstValue":{"$ref":"#/components/schemas/QuestionValue"},"lastValue":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"}}}],"required":["firstValue","lastValue","questionType","representation","title","voteMode"]}}},"paths":{"/api/v1/company/advisor/surveys/templates":{"post":{"tags":["advisors-survey-resource"],"operationId":"createSurveyTemplates","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SurveyTemplateDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SurveyTemplateDTO"}}}}}}}}}
```

## GET /api/v1/company/advisor/surveys/categories

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"SurveyTemplateCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"color":{"type":"string"},"iconPath":{"type":"string"}}},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]}}},"paths":{"/api/v1/company/advisor/surveys/categories":{"get":{"tags":["advisors-survey-resource"],"operationId":"getSurveyCategories","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SurveyTemplateCategoryDTO"}}}}}}}}}}
```

## POST /api/v1/company/advisor/surveys/categories

>

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"SurveyTemplateCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"color":{"type":"string"},"iconPath":{"type":"string"}}},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]}}},"paths":{"/api/v1/company/advisor/surveys/categories":{"post":{"tags":["advisors-survey-resource"],"operationId":"createSurveyCategory","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SurveyTemplateCategoryDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SurveyTemplateCategoryDTO"}}}}}}}}}
```
