curl --request GET \
--url https://v1.api.flux-os.com/entities/{id} \
--header 'x-api-key: <api-key>' \
--header 'x-user-id: <api-key>'{
"data": {
"legal_name": "<string>",
"effective_date": "2023-12-25",
"id": "<string>",
"organization": {
"name": "<string>",
"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": {
"legal_name": "<string>",
"id": "<string>"
},
"operated_facilities": [
{
"name": "<string>",
"id": "<string>",
"regulator_id": null
}
],
"licensed_facilities": [
{
"name": "<string>",
"id": "<string>",
"regulator_id": null
}
],
"licensed_wells": [
{
"regulator_id": "<string>",
"id": "<string>",
"name": null
}
],
"streams": [
{
"name": "<string>",
"id": "<string>"
}
],
"product_categories": [
{
"name": "<string>",
"id": "<string>"
}
],
"business_lines": [
{
"name": "<string>",
"id": "<string>"
}
]
}
}Retrieve details about a specific entity including associated producer, carrier, marketer and other entity types.
curl --request GET \
--url https://v1.api.flux-os.com/entities/{id} \
--header 'x-api-key: <api-key>' \
--header 'x-user-id: <api-key>'{
"data": {
"legal_name": "<string>",
"effective_date": "2023-12-25",
"id": "<string>",
"organization": {
"name": "<string>",
"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": {
"legal_name": "<string>",
"id": "<string>"
},
"operated_facilities": [
{
"name": "<string>",
"id": "<string>",
"regulator_id": null
}
],
"licensed_facilities": [
{
"name": "<string>",
"id": "<string>",
"regulator_id": null
}
],
"licensed_wells": [
{
"regulator_id": "<string>",
"id": "<string>",
"name": null
}
],
"streams": [
{
"name": "<string>",
"id": "<string>"
}
],
"product_categories": [
{
"name": "<string>",
"id": "<string>"
}
],
"business_lines": [
{
"name": "<string>",
"id": "<string>"
}
]
}
}The entity ID.
A single entity object containing entity details along with related entity type information.
Show child attributes
PETRINEX ALBERTA, SASKATCHEWAN START, INACTIVE_REACTIVATE_ELIGIBLE, LIQUIDATION, NON_REGISTERED, DISCONTINUED_NO_REACTIVATION, DISSOLVED, CONTINUED_OUT, ACTIVE, STRUCK, CONTINUED_OUT_AMALGAMATED, AMALGAMATED, DISSOLUTION/DISSOLVED