Skip to main content
GET
/
facilities
/
subtypes
List Sub Types
curl --request GET \
  --url https://v1.api.flux-os.com/facilities/subtypes \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>'
{
  "data": [
    {
      "name": "<string>",
      "code": "<string>",
      "facility_type": "<unknown>",
      "id": "<string>",
      "jurisdiction": "ALBERTA",
      "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
code
string

Filter by facility subtype code

jurisdiction
enum<string>

Filter by jurisdiction

Available options:
ALBERTA,
SASKATCHEWAN
facility_type
string

Filter by facility type ID

Response

A paginated list of facility subtypes.

data
object[]
meta
object