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

# Company Resource

## GET /api/v1/company

>

```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":{"CompanyDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"mainEmail":{"type":"string"},"mainAddress":{"type":"string"},"mainPhone":{"type":"string"},"imageUrl":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/CompanyAccountStatus"},"launchStatus":{"type":"string","enum":["CREATED","PRELAUNCH","LAUNCHED","CRUISE_SPEED"]}}},"CompanyAccountStatus":{"type":"string","description":"Status of a company account (active, blocked, paused)","enum":["ACTIVE","BLOCKED","PAUSED"]}}},"paths":{"/api/v1/company":{"get":{"tags":["company-resource"],"operationId":"getUserCompany","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompanyDTO"}}}}}}}}}
```

## POST /api/v1/company

>

```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":{"CompanyDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"mainEmail":{"type":"string"},"mainAddress":{"type":"string"},"mainPhone":{"type":"string"},"imageUrl":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/CompanyAccountStatus"},"launchStatus":{"type":"string","enum":["CREATED","PRELAUNCH","LAUNCHED","CRUISE_SPEED"]}}},"CompanyAccountStatus":{"type":"string","description":"Status of a company account (active, blocked, paused)","enum":["ACTIVE","BLOCKED","PAUSED"]}}},"paths":{"/api/v1/company":{"post":{"tags":["company-resource"],"operationId":"createForAdvisorCompany","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompanyDTO"}}}}}}}}}
```

## POST /api/v1/company/reset/{companyId}

>

```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":{"CompanyDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"mainEmail":{"type":"string"},"mainAddress":{"type":"string"},"mainPhone":{"type":"string"},"imageUrl":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/CompanyAccountStatus"},"launchStatus":{"type":"string","enum":["CREATED","PRELAUNCH","LAUNCHED","CRUISE_SPEED"]}}},"CompanyAccountStatus":{"type":"string","description":"Status of a company account (active, blocked, paused)","enum":["ACTIVE","BLOCKED","PAUSED"]}}},"paths":{"/api/v1/company/reset/{companyId}":{"post":{"tags":["company-resource"],"operationId":"resetCompany","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string"}},{"name":"secret","in":"query","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompanyDTO"}}}}}}}}}
```

## POST /api/v1/company/change/{companyId}

>

```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":{"UserDTO":{"type":"object","properties":{"id":{"type":"string"},"rememberMe":{"type":"boolean"},"multipleCompanies":{"type":"boolean"},"pureAdvisor":{"type":"boolean"},"name":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"},"profileImagePath":{"type":"string"},"email":{"type":"string"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"companyId":{"type":"string"},"language":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"addedOn":{"type":"string","format":"date-time"},"requiresPasswordChange":{"type":"boolean"}}},"ManagementFocus":{"type":"string","description":"The focus/interest a user has when consuming their report","enum":["TEAM_LEAD","MANAGER_OF_MANAGERS","EXECUTIVE","PEOPLE_ADVISOR","PEOPLE_EXECUTIVE","ACCOUNT_ADMIN","GENERIC"]},"UserNotificationSetting":{"type":"object","properties":{"type":{"type":"string","enum":["PRIVATE_COMMENT_RECEIVED","INAPPROPRIATE_COMMENT_RECEIVED","COMMENT_RECEIVED","QUESTION_FINISHED"]},"frequency":{"type":"string","enum":["IMMEDIATELY","NEVER"]}}}}},"paths":{"/api/v1/company/change/{companyId}":{"post":{"tags":["company-resource"],"operationId":"changeCompany","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserDTO"}}}}}}}}}
```

## GET /api/v1/company/{companyId}

>

```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":{"CompanyDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"mainEmail":{"type":"string"},"mainAddress":{"type":"string"},"mainPhone":{"type":"string"},"imageUrl":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/CompanyAccountStatus"},"launchStatus":{"type":"string","enum":["CREATED","PRELAUNCH","LAUNCHED","CRUISE_SPEED"]}}},"CompanyAccountStatus":{"type":"string","description":"Status of a company account (active, blocked, paused)","enum":["ACTIVE","BLOCKED","PAUSED"]}}},"paths":{"/api/v1/company/{companyId}":{"get":{"tags":["company-resource"],"operationId":"getCompanyById","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompanyDTO"}}}}}}}}}
```

## DELETE /api/v1/company/{companyId}

>

```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":{"UserDTO":{"type":"object","properties":{"id":{"type":"string"},"rememberMe":{"type":"boolean"},"multipleCompanies":{"type":"boolean"},"pureAdvisor":{"type":"boolean"},"name":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"},"profileImagePath":{"type":"string"},"email":{"type":"string"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"companyId":{"type":"string"},"language":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"addedOn":{"type":"string","format":"date-time"},"requiresPasswordChange":{"type":"boolean"}}},"ManagementFocus":{"type":"string","description":"The focus/interest a user has when consuming their report","enum":["TEAM_LEAD","MANAGER_OF_MANAGERS","EXECUTIVE","PEOPLE_ADVISOR","PEOPLE_EXECUTIVE","ACCOUNT_ADMIN","GENERIC"]},"UserNotificationSetting":{"type":"object","properties":{"type":{"type":"string","enum":["PRIVATE_COMMENT_RECEIVED","INAPPROPRIATE_COMMENT_RECEIVED","COMMENT_RECEIVED","QUESTION_FINISHED"]},"frequency":{"type":"string","enum":["IMMEDIATELY","NEVER"]}}}}},"paths":{"/api/v1/company/{companyId}":{"delete":{"tags":["company-resource"],"operationId":"deleteCompany","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string"}},{"name":"secret","in":"query","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserDTO"}}}}}}}}}
```

## GET /api/v1/company/list

>

```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":{"PaginableGenericResultListCompanyDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"result":{"type":"array","items":{"$ref":"#/components/schemas/CompanyDTO"}}}},"CompanyDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"mainEmail":{"type":"string"},"mainAddress":{"type":"string"},"mainPhone":{"type":"string"},"imageUrl":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/CompanyAccountStatus"},"launchStatus":{"type":"string","enum":["CREATED","PRELAUNCH","LAUNCHED","CRUISE_SPEED"]}}},"CompanyAccountStatus":{"type":"string","description":"Status of a company account (active, blocked, paused)","enum":["ACTIVE","BLOCKED","PAUSED"]}}},"paths":{"/api/v1/company/list":{"get":{"tags":["company-resource"],"operationId":"getCompanies","parameters":[{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"to","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PaginableGenericResultListCompanyDTO"}}}}}}}}}
```
