Skip to main content
GET
/
facilities
List Facilities
curl --request GET \
  --url https://v1.api.flux-os.com/facilities \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>'
{
  "data": [
    {
      "name": "<string>",
      "type": "<unknown>",
      "sub_type": "<unknown>",
      "start_date": "2023-12-25",
      "operator": "<unknown>",
      "operator_start_date": "2023-12-25",
      "id": "<string>",
      "latitude": null,
      "longitude": null,
      "lsd": null,
      "section": null,
      "township": null,
      "range": null,
      "meridian": null,
      "operational_status": "ABANDONED",
      "licensee": "<unknown>",
      "license_status": "ABANDONED",
      "license_type": "WELL",
      "license_number": null,
      "license_issued": null,
      "jurisdiction": "ALBERTA",
      "regulator_id": null,
      "regulator_system": "PETRINEX"
    }
  ],
  "meta": {
    "current_page": 123,
    "total_pages": 123,
    "total_items": 123,
    "per_page": 123
  }
}

Authorizations

x-api-key
string
header
required
x-user-id
string
header
required

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
name
string

Filter by facility name

type_id
integer

Filter by facility type ID

subtype_id
integer

Filter by facility subtype ID

status
string

Filter by facility status

operator_id
integer

Filter by operator ID

licensee_id
integer

Filter by licensee ID

regulator_id
string

Filter by regulator ID

model_name
enum<string>

Filter by facility model name

Available options:
Terminal,
Station,
Plant,
Battery,
System,
Pipeline,
Rail Line
lsd
integer

Filter by legal subdivision (LSD)

section
integer

Filter by section number

township
integer

Filter by township number

range
integer

Filter by range number

meridian
string

Filter by meridian

Response

A paginated list of terminals.

data
object[]
meta
object