Skip to main content
GET
/
organization
/
entities
List Entities
curl --request GET \
  --url https://v1.api.flux-os.com/organization/entities \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>'
{
  "data": [
    {
      "legal_name": "<string>",
      "effective_date": "2023-12-25",
      "id": "<string>",
      "organization": "<unknown>",
      "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>"
    }
  ],
  "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

Response

A paginated list of entities.

data
object[]
meta
object