Organisations

List organisations of the installation

GET/v4/onboard/platform/operator/organisations

Lists the organisations of the installation, newest first, with the numbers of all organisations in each state. The platform operator organisation is in the list. All filters must match. The member statistics counts all organisations, without the filters.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/onboard/platform/operator/organisations' \
  -H 'Authorization: Bearer <access-token>'

{
  "organisations": [
    {
      "id": "6731f0c2a1b2c3d4e5f60789",
      "name": "Acme Bank",
      "location": "Stockholm, Sweden",
      "type": {
        "id": "64e0c1a2b3c4d5e6f7a8b9c0",
        "type": "Banking"
      },
      "policyUrl": "https://acme-bank.example.com/privacy",
      "status": "active",
      "isPlatformOperator": false,
      "superAdminCount": 1,
      "createdAt": "2026-11-12T08:15:00Z",
      "suspendedAt": null,
      "wallet": {
        "deploymentStatus": "deployed",
        "walletOrganisationId": "2f6c1d0e-8b7a-4c3d-9e1f-0a2b3c4d5e6f",
        "isWalletProvider": false
      },
      "features": {
        "enabled": 1,
        "total": 4
      }
    },
    {
      "id": "6731e9a0a1b2c3d4e5f60701",
      "name": "Example Wallet Provider",
      "location": "Stockholm, Sweden",
      "type": {
        "id": "64e0c1a2b3c4d5e6f7a8b9c1",
        "type": "Technology"
      },
      "policyUrl": "https://wallet-provider.example.com/privacy",
      "status": "active",
      "isPlatformOperator": true,
      "superAdminCount": 1,
      "createdAt": "2026-11-01T10:00:00Z",
      "suspendedAt": null,
      "wallet": {
        "deploymentStatus": "deployed",
        "walletOrganisationId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "isWalletProvider": true
      },
      "features": {
        "enabled": 4,
        "total": 4
      }
    }
  ],
  "statistics": {
    "total": 2,
    "active": 2,
    "invited": 0,
    "suspended": 0,
    "deleting": 0,
    "walletNotDeployed": 0
  },
  "pagination": {
    "currentPage": 1,
    "totalItems": 2,
    "totalPages": 1,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": false
  }
}

Authorizations

Authorizationstringheaderrequired
An access token: Bearer <access-token>.

Query parameters

searchstring
A part of the name of the organisation, in any letter case.
Example:"acme"
statusenum<string>
Only the organisations in this state.
Available options:invited,active,suspended,deleting
walletDeploymentenum<string>
deployed: only the organisations with a deployed organisation wallet, also an organisation in deletion. notDeployed: only the organisations whose wallet is not deployed, without the organisations in deletion.
Available options:deployed,notDeployed
walletOrganisationIdsstring
Only the organisations with these IDs in the organisation wallet (wallet.walletOrganisationId), separated by commas, at most 100. For example, find the organisation of an organisation wallet unit with its holderOrganisationId. An empty value matches no organisation.
Example:"2f6c1d0e-8b7a-4c3d-9e1f-0a2b3c4d5e6f"
withoutWalletUnitbooleandeprecated
true: only the organisations whose wallet is not deployed, also the organisations in deletion. The filter of an earlier release: use walletDeployment=notDeployed.
offsetinteger
The number of items to skip. A value that is not a whole number from 0 to 10000 gets 400.
From 0 to 10000.
Default:0
limitinteger
The number of items on a page, at least 1. A larger value than 100 gives 100 items.
At least 1.
Default:10

Response

application/json

One page of organisations, and the numbers of all organisations.

organisationsobject[]
statisticsobject
The numbers of all organisations of the installation, without the filters. total is the sum of active, invited, suspended and deleting; an organisation in deletion counts only in deleting. walletNotDeployed is not part of the sum: it is the number that walletDeployment=notDeployed selects.
paginationobject