---
id: onboard-operator-list-platform-admin-candidates
title: "List platform admin candidates"
description: "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](/docs/openid4vc-api/onboard-operator-grant-platform-admin). To give the right to a new person, first add them as an admin of the platform operator organisation."
sidebar_label: "List platform admin candidates"
hide_title: true
hide_table_of_contents: true
api: eJztWltz2zYW/itn8LL2DCVRttsm2k6nju12lGYTT+3WO2t7Qpg8klCTAAuAkrUe/fedA/Au2XGy2Zed9iG1SODcLx8O+MgSNLEWuRVKsgl7J4w1YBcIPMmENKBm7leecjtTOgOVo+ZWaVB6zqUwnDbCStiFKmx3qaMAWswXNgCJKzQWZkIbO2kzWC0UxFzCHC0I6yjB9c9iuZvQ7d4oUbEZqRylSI6W8YDnYqTkneI6GVTCDeaaSzuoCAwcgf0hXCqYE2Vi78iBVcBJNshRGyUDLyDwJKFFGXADXJYCvMgUQxYw/0IoOU3YhJXCfShXk4XPSxLHRPeEy0Qk3KJhAbN8btjkml0UOerKRFwmPWMYdhswg3GhhV2zyfUje4Ncoz4u7IJNrm83twHLueYZWtTGLZA8QzZhBrmOFyxggtz9Z4F6zQKm8c9CaEzYZMZTg0EvKo4h59pWBiBKQGr7nzjIuEjJZBpNHTBOzACEBC7XkKK1qCHmBslAJl5gxtnkkdl17qSyWsg5Cxg+8CxP6dEfXCLbbIJGcsttYT5T8g8yXXt54lgV0hqSyC6EASL3KWFkkZEzhFwKiwkLGI+tWCIj4xqzUjo5WXA5x18rIQKWCMPvUkzYbVt2NZsZtJ8p+yXZusju0JlaWMwMxau5F/kQjmHJ04JCmVsQBqSywCmZ0nrTTKsMQtoyDsMwpAwzEB2FYbRTbSEtzlGTDjjjRWrZJAxYJqTIyAz0N3/wfzt6bf1SkYmvoZ6SwCHncwyAW0iRGwtjUjbleo660VmSTi6ZjfvLbX+pWuO2XuMNJYtGkytp0NDOgzCk//UjCZ1kJGwVTMQwVtKitLSB53kqYpf5oz8M7Xrclkfd/YGx7ZjnmpVJTXE1F9JRoAzPNZUSK7xY5aKGFNeak6Gd8rtYWGFdLlW159jLzbbyuypxpWKu7PXrr0E0IOywJ7qgqEcqASzw4RAwrVJ87/9s10ZyT5XEKTf2QszllJ7m7Xq4rbhIdmXndjRNTzvVZ9ipJ99+dziejZNXfHx3EB8mR/jN7Nvwu1ecbSrxX8TjmWo33Kpfw0ThjzzOcHDH5f2wfDmMVUZcfe68hKmvuE+yesslwqlCIlqb/pl65s0csNNc0b+4xJTMzQLfdqrX75XOeFr7ZFss4tURi4qrsKbbEOEYTNPNYMENRA2fqKtKS4BNL3h2xPe2SB1U0rfYVtg6D3yFcOsDgF7UhfFBL+pef7n/n+Z1HGcIb7i8Z5vNpk61r97Xdgnommltb19EhhCVDKIW4HP+p2Zl0Lpa7/nBGmnDbvad/Vlhqs0Ot1UEuEefEh8spGpO4GOmNJTmAT4jAMJBSRxYkWG9cQhRpVs02a56ija147da3FG144fSmJtOkdvhBlmkKZFiE6uLne3RCVpalWh5xXoQS2mIiFQEdzhT2qNbD2Pd8q5wB+HBt4PxeDA+uAxfTw7DSRj+i0TtluAdufa8tFcLBXNeQutdwN2B2NUCOwKTg2p43T5DuC39lHWgHpM31PLKv4/tdvo2yz47t3qCr9pKeS32diPeLSW4o7sfQFSdEk5UlnGZRM4IwCH2vyvWQhrL09QXLsdUWGcqu93YPAmH/PzvmEtKqTsEjTzpOrzHn3zdGG+HhUh/btmE0ZHEpcqW2a48+8omK24cEpOw9+tPJ3B4ePg6gN8uT/afjrxXk7CMPPdfB/c8g2POm1V9r8eF1ijtOZ/jE+CvrcGJX+0BnQehbVnHm4BZZXk67SGrp+hd0uItNMuXXPicadE++KYiTrJ+CXES2sAdN5gQYK6wd83hkCqPe/hp2u97IlOdI/oda4SbgC24Ode4FKrTUu6USpHLLbJTmRAQJsDo4lbj3xyiLClssXAHBM/lPT7YL+fgyn+fOhWsMs7qZw2cvvYd37Vq5OOw26rDwxreUi6ZH1c8TdEOcq2WIkHdAXVVTy8Bt1DSwDvkSRsST2r41Uc3jRSveV+KcUP7rOxoV04QOC8FYa2W3/TzdgdqMjC8HB9NDnwGbpV+Ks1+ftBOyU5+jbvpMe4G9LgOPzpodQKnPAjWbvZ+d55ZIE/crOKRfh3tOoI5zIl/FjRIKo+8S56KBPYi1FrpX3AdOdBBDz+WK6P9SRcIwJ1K1p1z89uLD+8D4JChSwb3ykGtyouQKPRL76VauaXCGCHnUPWncm/g8YI7Ae86oKepWiFBDifvaaNd5PqFn7x5Up91tmy3SUf6RCUuBXpsqFv2i2u3jja7dxWPOn2OQioKW+Sfnei84QkImReUoOVoilVEfsEXtOtjsJTesUrqjq1xVhieeivXXoodfKzaJJbb3EMzBDcTMiqrdxtYVA23HSlRO0E/msLkKBNMogCiGXJbaPxYI0cHavJC58rgR3ygKWo0ZP2S0zLuURi2VWe9qN3luwmbCUwT8FnugfAdwg2rRbthJMdNmf43jO3MrPHuzIpoeKi0+Df3Aem3UeiWwV7DER7HhHusukfZTUSlHb7Hh5yi8a8Q/r8I4V0xdLg7hmLqSbrCo/SrW0g9WO7hbDffqw42DZJeqGau2QPme+2ZPJeK+n/nYOzr8GcN7j95h7FfDlBbrUYq+7Fa+pH7cQYcSzg+n8I9rv0GZ4CUUsk1nujxhlFw3rAAbtg/0Bg+xxu2iSYgVb2TbkQq85m2AT8rp7hcf5g5hPPl2UVT3ifnik4tR8Mpt3tiVr9uDQiofsQLjO/rZ7kIoDwP+cBWBaG75jXESmP/TFiqUZqR3W5un6m4h52Ku+283UX32EuboBSYTEBR6m2PCV4UYi2vCuM13C7Rm4BlaBeK0ODcXRrknG512Gh5VN10jSpGo4rRyMPZUdy+TTKol9X9T9cxp5gp8K9ZwApN6HZhbW4mo1GCmaJrtaFwB8WhUC4IugTOtUqK2Gn1BJlPUbiwBDDnT203/nVfkNa91wXFuS/5x7noll/uH5Q3Et68DYTudLqtoL1A6ac7VTIKX4KfaJDuxtI5X+NMPEDkhYEI9twrDibnMe5PegQmUC78nudicI/rH6IhnGikSRpv8024WTivQyGJYTnFhx+gHt2SqIbqKG0zlmtrvFyRWpn7j9HfuxR9OXp7dQkuWPciXL8dDofRfn1HNI6GcMbjRQsDNwDVxCrHBiYTYYmYmEnJpaqkwtb0DqNKOieWks0808niSBqIYiVnYu57URnrUZM2uCRc7fKmtEVESdHe1EqShqXS98YnbmWAzphYg+EyuVMP3eceuTvwfqcKigk1gUSV00uZQPTPwYXf+EHPpzTaId2Epf7ke9JOuo1N/JW0xjzlcen0AOIqBGi8qSQGUBjf2S2BgQRTtFiZjhYM4Woh3MmmV5QIitU9f1vvPZ4aVQ5GaWrvKLuEpgDCZD8oDe5sX+pmmsbmwqQMs1ZTfAJyDIGagT89twHBXsuFI7Uy0b7HCE+7hOZN3goJcGlWFAZH47ASpcM/QYeFOU2hhwTV2vfkdbWgmlPdHbqhg1vEgvKPn6qR2Nury50trgOI2yCmHER/ZgHxMkK0XTHKN997hgPH8IfStK0yYfxNnXvcxV7b4MaA5ffos8O1JUf0STCSESSksjpTbiygpOWxgyLVkMQUea60/bEp2nXdFT83j7rVvt0odhi43uhkmpXnkC58c5E1AWFMgZRECUorCBk7+37IUU5Pj34/mcJ4GAawRC1ma/+RR2fBuX+/oORqUyl9WAXwDNaq6INOwi88Lq9Py5X1oAimFkrbGJieXf4EF6cDqsG/nwQwvfgwmp6dwPhVOD4cfANZomLYy07f7TuiV4cn8PsJ7L29utxvS+VqApz9djqtxkG0+qyg8xCX8KYwQlJkXtWyzESKxktKW0/FXNB08aSl6fH5lGBWKmKUxqGoqm3mPF4gHAzDLf+tVqshd6+HSs9H5V4zejc9OXt/cTagPZsGOHb9mai4yFDaqh0TZvG+PwgPjoaHw7G7oVDGZly25KFPafo1r4N/ku65rsbNf33m9DU+cyqLJ51MCY/6K1sXFo8lZL1myyMadHq5W6PG+iMpRVW2/vqh5bzbgC2UsUTj8ZFm3b/pdLOhx/7zEgdpqzvJnR+YtP39tT9g2qn6vTtW1B9YufEfmzAPfV8s6gu+WHqOe/V9xRdy/99+c/SM4PUXUl9R8P/+a6JnBK6uXRp5b+mHFv6S9Pq2Pta5WPWb6CyZt3dtnd+JSn38+/mM8AbvgpUeOHHUq1OPXLdof1+ihUuHElgluOvvbHO72Wz+A+WniUk=
sidebar_class_name: "get api-method"
info_path: docs/openid4vc-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List platform admin candidates</h1>

<MethodEndpoint method={"get"} path={"/v4/onboard/platform/operator/admins/candidates"}></MethodEndpoint>



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](/docs/openid4vc-api/onboard-operator-grant-platform-admin). To give the right to a new person, first add them as an admin of the platform operator organisation.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"search","in":"query","required":false,"description":"A part of the name or of the e-mail address of the admin, in any letter case.","schema":{"type":"string","example":"jane"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"status","in":"query","required":false,"description":"Only the accounts in this state.","schema":{"type":"string","enum":["invited","active","passwordChangeRequired","disabled"]}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"offset","in":"query","required":false,"description":"The number of items to skip. A value that is not a whole number from 0 to 10000 gets `400`.","schema":{"type":"integer","default":0,"minimum":0,"maximum":10000}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","required":false,"description":"The number of items on a page, at least 1. A larger value than 100 gives 100 items.","schema":{"type":"integer","default":10,"minimum":1}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

One page of accounts.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>admins</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the admin.","example":"6731f1d8a1b2c3d4e5f6078a"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The e-mail address of the admin.","example":"jane.doe@acme-bank.example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the admin.","example":"Jane Doe"}}></SchemaItem><SchemaItem collapsible={false} name={"roleName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`Admin`, `Dpo`, `Developer`, `SuperAdmin`, `NormalAdmin`]"} schema={{"type":"string","enum":["Admin","Dpo","Developer","SuperAdmin","NormalAdmin"],"description":"The role of the admin in its organisation. A super admin has `SuperAdmin`.","example":"SuperAdmin"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>organisation</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

The organisation of the admin.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the organisation.","example":"6731f0c2a1b2c3d4e5f60789"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the organisation.","example":"Acme Bank"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`invited`, `active`, `passwordChangeRequired`, `disabled`]"} schema={{"type":"string","enum":["invited","active","passwordChangeRequired","disabled"],"description":"The state of the account. `invited`: the admin has not set a password yet. `passwordChangeRequired`: the admin must set a new password at the next login, for example after a one-time password. `disabled`: a platform admin or a super admin disabled the account.","example":"active"}}></SchemaItem><SchemaItem collapsible={false} name={"lastSignIn"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The time of the last login of the admin, or `null` before the first login.","example":"2026-11-12T09:30:00Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>platformAdmin</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Who gave the platform admin right and when, or `null` for an admin without the right.

</div><SchemaItem collapsible={false} name={"grantedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the platform admin who gave the right (the e-mail address of an admin without a name), `operatorCommand` when a command of the installation gave it, or the ID of the admin when that admin cannot be read.","example":"operatorCommand"}}></SchemaItem><SchemaItem collapsible={false} name={"grantedAt"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the right was given (RFC 3339, UTC).","example":"2026-11-12T08:00:00Z"}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"admins\": [\n    {\n      \"id\": \"6731f1d8a1b2c3d4e5f6078a\",\n      \"email\": \"jane.doe@acme-bank.example.com\",\n      \"name\": \"Jane Doe\",\n      \"roleName\": \"SuperAdmin\",\n      \"organisation\": {\n        \"id\": \"6731f0c2a1b2c3d4e5f60789\",\n        \"name\": \"Acme Bank\"\n      },\n      \"status\": \"active\",\n      \"lastSignIn\": \"2026-11-12T09:30:00Z\",\n      \"platformAdmin\": {\n        \"grantedBy\": \"operatorCommand\",\n        \"grantedAt\": \"2026-11-12T08:00:00Z\"\n      }\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"admins\": [\n    {\n      \"id\": \"6731ea10a1b2c3d4e5f60703\",\n      \"email\": \"ops@wallet-provider.example.com\",\n      \"name\": \"Operations Lead\",\n      \"roleName\": \"Admin\",\n      \"organisation\": {\n        \"id\": \"6731e9a0a1b2c3d4e5f60701\",\n        \"name\": \"Example Wallet Provider\"\n      },\n      \"status\": \"active\",\n      \"lastSignIn\": \"2026-11-10T14:20:00Z\",\n      \"platformAdmin\": null\n    }\n  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 1,\n    \"totalPages\": 1,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": false\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

The request is not valid (`errorKey` `invalid_request`): for example a body that is not JSON, a member that the operation does not know, a missing required member, or a query value that is not allowed. `errorDescription` names the member.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem><SchemaItem collapsible={false} name={"errorKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text code of the refusal that does not change when the text changes. Only some refusals have it, for example `organisation_suspended`, `feature_disabled` or `purpose_exists`."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\",\n  \"errorKey\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorKey\": \"invalid_request\",\n  \"errorDescription\": \"field status must be \\\"suspended\\\" or \\\"active\\\"\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

The `Authorization` header is missing, or the access token is not valid or has expired.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem><SchemaItem collapsible={false} name={"errorKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text code of the refusal that does not change when the text changes. Only some refusals have it, for example `organisation_suspended`, `feature_disabled` or `purpose_exists`."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\",\n  \"errorKey\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

The caller cannot call the operations of a platform admin. A login of an admin who is not a platform admin (an admin of another organisation, or an admin of the platform operator organisation without the platform admin right) gets `errorKey` `not_platform_admin`. An API key gets the older body `{"Code", "Message"}`: no API key can call these operations.

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem><SchemaItem collapsible={false} name={"errorKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text code of the refusal that does not change when the text changes. Only some refusals have it, for example `organisation_suspended`, `feature_disabled` or `purpose_exists`."}}></SchemaItem></TabItem><TabItem label={"Older error body"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"Code"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The HTTP status.","example":403}}></SchemaItem><SchemaItem collapsible={false} name={"Message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"What went wrong.","example":"Unauthorized access;User doesn't have enough permissions;"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"errorCode\": 403,\n  \"errorKey\": \"not_platform_admin\",\n  \"errorDescription\": \"Access denied: only a platform admin of the platform operator organisation can call this route\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>