Super admins and platform admins

List platform admin candidates

GET/v4/onboard/platform/operator/admins/candidates

Lists the admins of the platform operator organisation without the platform admin right, newest first: the admins who can get it with Give platform admin right. To give the right to a new person, first add them as an admin of the platform operator organisation.

Language of the request sample

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

{
  "admins": [
    {
      "id": "6731ea10a1b2c3d4e5f60703",
      "email": "[email protected]",
      "name": "Operations Lead",
      "roleName": "Admin",
      "organisation": {
        "id": "6731e9a0a1b2c3d4e5f60701",
        "name": "Example Wallet Provider"
      },
      "status": "active",
      "lastSignIn": "2026-11-10T14:20:00Z",
      "platformAdmin": null
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 1,
    "totalPages": 1,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": false
  }
}

Authorizations

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

Query parameters

searchstring
A part of the name or of the e-mail address of the admin, in any letter case.
Example:"jane"
statusenum<string>
Only the accounts in this state.
Available options:invited,active,passwordChangeRequired,disabled
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 accounts.

adminsobject[]
paginationobject