# List facilities

**GET /api/facilities**

Allows you to retrieve the paginated list of facilities that you have access to.


## Servers
- http://localhost:4000: http://localhost:4000 ()


## Authentication methods
- Api key


## Parameters


### Query parameters
- **filter** (string)
  criteria to filter by
- **sort** (string)
  criteria to sort by
- **limit** (string)
  amount of results per page to return
- **page** (string)
  page number
- **start** (string)
  ISO8601 formatted date to query data from
- **format** (string)
  Format in which to request the response. Defaults to JSON
- **includes** (string)
  optional features to include. This is a list of values separated by colons ':'. The avaiable values are: cycle_count (adds cycles_count), utilization_times (adds utilization_minutes and working_minutes), energy_usage (adds kwh_usage and gas_usage), active_alerts (adds active_alerts_count), service_events_count (adds service_events and events_missed), and overuse_data (adds overuse_minutes and overuse_cycles)
- **search** (string)
  criteria to search by
- **end** (string)
  ISO8601 formatted date to query data until


## Responses
### 200
OK

#### Body: application/json (object)
- **data** (array[object])
  Facilities data
- **limit** (number)
  The number of items per page currently applied
- **page** (number)
  The number of the page returned
- **pages** (number)
  The total number of pages matching the current search
- **total** (number)
  The total number of facilities matching the query

### 401
Unauthorized

#### Body: application/json (object)
- **error** (string)
  Human readable version of the error status code


[Powered by Bump.sh](https://bump.sh)