Skip to main content
GET
/
organization
Get Organization
curl --request GET \
  --url https://v1.api.flux-os.com/organization \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>'
{
  "data": {
    "name": "<string>",
    "slug": "<string>",
    "id": "<string>",
    "url": null,
    "phone": null,
    "email": null,
    "image_url": null,
    "short_code": null,
    "entities": [
      {
        "legal_name": "<string>",
        "effective_date": "2023-12-25",
        "id": "<string>",
        "url": null,
        "phone": null,
        "email": null,
        "unit": null,
        "street": null,
        "city": null,
        "zip_code": null,
        "province": null,
        "state": null,
        "postal_code": null,
        "country": null,
        "regulator_id": null,
        "regulator_system": "PETRINEX",
        "jurisdiction": "ALBERTA",
        "status": "START",
        "successor": "<unknown>",
        "business_lines": "<unknown>"
      }
    ]
  }
}

Authorizations

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

Response

A single organization object containing organization details along with related entities, wells, terminals, plants, batteries, stations, systems and pipelines.

data
object