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

# Overview Resource

## GET /api/v1/company/overview

>

```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":{"OverviewDTO":{"type":"object","properties":{"id":{"type":"string"},"periodMonth":{"type":"string","format":"date"},"status":{"type":"string","enum":["PENDING","RUNNING","COMPOSED","FAILED","SKIPPED"]},"tree":{"$ref":"#/components/schemas/JsonNode"},"envelope":{"$ref":"#/components/schemas/JsonNode"}}},"JsonNode":{}}},"paths":{"/api/v1/company/overview":{"get":{"tags":["overview-resource"],"operationId":"getOverview","parameters":[{"name":"overviewId","in":"query","description":"Id of the overview to read, from /periods; the latest month when omitted","required":false,"schema":{"type":"string"}},{"name":"asManagerId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OverviewDTO"}}}}}}}}}
```

## GET /api/v1/company/overview/periods

>

```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":{"PaginableGenericResultListOverviewPeriodDTO":{"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/OverviewPeriodDTO"}}}},"OverviewPeriodDTO":{"type":"object","properties":{"id":{"type":"string"},"periodMonth":{"type":"string","format":"date"}}}}},"paths":{"/api/v1/company/overview/periods":{"get":{"tags":["overview-resource"],"operationId":"getPeriods","parameters":[{"name":"from","in":"query","description":"Zero-based start index (default 0)","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"to","in":"query","description":"Exclusive end index (default 12)","required":false,"schema":{"type":"integer","format":"int32","default":12}},{"name":"asManagerId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PaginableGenericResultListOverviewPeriodDTO"}}}}}}}}}
```
