Skip to main content
GET
/
v4
/
facilities
/
{
  "version": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "success": true,
  "error": "<string>",
  "data": [],
  "total_records": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
facility_code
string[] | null

Filter by facility code(s)

​
status_id
enum<string>[] | null

Filter by unit status(es)

​
fueltech_id
enum<string>[] | null

Filter by unit fuel technology type(s)

​
network_id
string[] | null

Filter by network code(s)

​
network_region
string | null

Filter by network region

​
with_clerk
boolean
default:true

Response

Successful Response

​
version
string
​
created_at
string<date-time>
​
success
boolean
default:true
​
error
string | null
​
data
any[]
​
total_records
integer | null