# Companies

Endpoints from `companies` routes module.

## List all companies

 - [GET /v1/companies](https://timify-dev-api.redocly.app/apis/openapi/companies/getv1companies.md): This endpoint fetches company data. This endpoint can be used in the app context (with app token) or company context (by the client with its company token) __Only one__ of the following parameters is required: - company_id - enterprise_id - external_company_id If you want to filter by _service_id_ or _external_service_id_ it is __mandatory__ to provide __at least__ one parameter from the previous list.

## Toggle online status of the company

 - [PUT /v1/companies/onlinestatus](https://timify-dev-api.redocly.app/apis/openapi/companies/putv1companiesonlinestatus.md): If it is currently activated, it will be deactivated and vice versa.

## Fetch company statistics

 - [GET /v1/companies/statistics](https://timify-dev-api.redocly.app/apis/openapi/companies/getv1companiesstatistics.md): Return aggregate booking and usage statistics for the company.

## Get settings

 - [GET /v1/companies/{id}/settings](https://timify-dev-api.redocly.app/apis/openapi/companies/getv1companiesbyidsettings.md): Retrieve configurable settings for the company.

## Put settings

 - [PUT /v1/companies/{id}/settings](https://timify-dev-api.redocly.app/apis/openapi/companies/putv1companiesbyidsettings.md): This endpoint updates the footfall for a branch or store. It requires seven objects, one for each day of the week starting with SUNDAY Footfall is determined by a colour scale:  GREEN  YELLOW  ORANGE  RED GREEN means low occupancy, RED is maximum occupancy. At high occupancy, the number of free slots is reduced. Note: The default footfall is GREEN (low occupancy) Example configuration for one day of the week: json { "isActive": true, "intervals": [ { "begin": "08:00", "end": "09:00", "footfall": "GREEN" }, { "begin": "18:00", "end": "18:30", "footfall": "YELLOW" }, { "begin": "18:30", "end": "19:30", "footfall": "ORANGE" }, { "begin": "19:30", "end": "20:00", "footfall": "RED" } ] }  If the store is closed or you do not want to specify footfall for the day, the data structure looks like this: json { "isActive": false, "intervals": [] }  The time ranges needs to be sorted by the begin parameter This is valid object json { "isActive": true, "intervals": [ { "begin": "08:00", "end": "09:00", "footfall": "GREEN" }, { "begin": "11:00", "end": "14:00", "footfall": "YELLOW" } ] }  This is an invalid object json { "isActive": true, "intervals": [ { "begin": "11:00", "end": "14:00", "footfall": "YELLOW" }, { "begin": "08:00", "end": "09:00", "footfall": "GREEN" } ] }