Organisations List

/organisations

Returns a paginated list of all organisations accessible to the authenticated user.

Request parameters

Responses

{
  "items": [
    {
      "id": "019e4fa4-8531-724d-82a7-8fe1812499f2",
      "name": "Acme Inc.",
      "status": "ACTIVE",
      "features": [
        "CHAT",
        "MEDIPLAN"
      ],
      "deletedAt": null,
      "metadata": {
        "title": "Welcome to your benefits page",
        "schema": "light",
        "setupStage": null
      }
    },
    {
      "id": "019e500d-0519-7e60-b43b-e3f85090bc7c",
      "name": "Interpublic",
      "status": "DELETED",
      "features": [],
      "deletedAt": "2026-07-08T14:01:30+00:00",
      "metadata": {}
    },
    {
      "id": "019e500f-3b99-7f11-8d50-9a12804b1b9c",
      "name": "BX Ops",
      "status": "DRAFT",
      "features": [
        "MEDIPLAN"
      ],
      "deletedAt": null,
      "metadata": {
        "schema": "dark"
      }
    }
  ],
  "page": 1,
  "perPage": 10,
  "total": 3,
  "totalPages": 1
}

{
  "error": "Invalid sort field."
}

Query Behavior Details

Filtering Rules

Currently, filtering is restricted to the status field. Omitting it returns organisations of all statuses.

Exact Match: The filter performs a strict equality check (=). Partial matches, "starts with", and "not like" are not supported.
Case-Sensitive: The value must match the uppercase enum casing exactly.
Single Value Only: One status per request. Arrays (e.g. status[]=ACTIVE&status[]=DRAFT) and comma-separated lists are not supported.

Sorting Rules

Sortable fields are id and status. Note the asymmetry with filtering: status can be both filtered and sorted, while id is sort-only — it cannot be used as a filter.

Defaults: If you omit both sorting parameters, the API sorts by status ASC, then id DESC.
Dependencies: If you provide sortBy, you must also provide sortOrder (and vice-versa).

01 September 2026