cURL
curl --request GET \ --url https://v1.api.flux-os.com/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 } }
Retrieve a list of entities with pagination and filtering options.
Page number for pagination
x >= 1
Filter by legal name
Filter by business line ID
Filter by regulator ID
Filter by jurisdiction
ALBERTA
SASKATCHEWAN
A paginated list of entities.
Show child attributes
PETRINEX
START
INACTIVE_REACTIVATE_ELIGIBLE
LIQUIDATION
NON_REGISTERED
DISCONTINUED_NO_REACTIVATION
DISSOLVED
CONTINUED_OUT
ACTIVE
STRUCK
CONTINUED_OUT_AMALGAMATED
AMALGAMATED
DISSOLUTION/DISSOLVED