> 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/enps-configuration-resource.md).

# Enps Configuration Resource

## GET /api/v1/company/enps/configuration

>

```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":{"ENPSConfigurationDTO":{"type":"object","properties":{"questionId":{"type":"string"},"enabled":{"type":"boolean"},"fullPeriod":{"type":"boolean"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"shortDescription":{"$ref":"#/components/schemas/MultiLanguage"},"reason":{"$ref":"#/components/schemas/MultiLanguage"},"reasonTitle":{"$ref":"#/components/schemas/MultiLanguage"},"reasonDescription":{"$ref":"#/components/schemas/MultiLanguage"},"first":{"$ref":"#/components/schemas/QuestionValue"},"last":{"$ref":"#/components/schemas/QuestionValue"},"measuringNow":{"type":"boolean"},"lastMeasure":{"type":"string","format":"date-time"},"nextMeasure":{"type":"string","format":"date-time"},"numberOfMeasures":{"type":"integer","format":"int32"},"currentPeriodHasVotes":{"type":"boolean"}}},"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"]},"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"]}}},"paths":{"/api/v1/company/enps/configuration":{"get":{"tags":["enps-configuration-resource"],"operationId":"getENPSConfiguration","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ENPSConfigurationDTO"}}}}}}}}}
```

## POST /api/v1/company/enps/configuration

>

```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":{"ENPSConfigureRequest":{"type":"object","properties":{"enabled":{"type":"boolean"},"reason":{"$ref":"#/components/schemas/MultiLanguage"},"reasonTitle":{"$ref":"#/components/schemas/MultiLanguage"},"reasonDescription":{"$ref":"#/components/schemas/MultiLanguage"},"fullPeriod":{"type":"boolean"}}},"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/enps/configuration":{"post":{"tags":["enps-configuration-resource"],"operationId":"configureENPS","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ENPSConfigureRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}}}}
```

## GET /api/v1/company/enps/configuration/schedules

>

```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":{"ENPSCurrentStatus":{"type":"object","properties":{"hasSchedule":{"type":"boolean"},"measuringNow":{"type":"boolean"},"hasVotes":{"type":"boolean"},"measureFrom":{"type":"string","format":"date-time"},"measureTo":{"type":"string","format":"date-time"}}}}},"paths":{"/api/v1/company/enps/configuration/schedules":{"get":{"tags":["enps-configuration-resource"],"operationId":"getCurrentStatus","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ENPSCurrentStatus"}}}}}}}}}
```
