Skip to main content
Manage Extension

List extensions

GET/v4/config/platform/extensions

Lists every extension of the platform with its status in your organisation: disabled, awaitingKey or enabled.

Use it to find the ID of an extension before you turn it on or off, and to see if an extension takes a signing key (takesSigningKey) and which key its definitions use (signingKeyId). An extension in the status awaitingKey was turned on without a signing key: it does not run until you choose its key with Turn an extension on or off. When Passwordless Login (oidc) is enabled, its entry also holds metadataUrl, the OpenID Connect discovery URL that you give to your identity and access management system.

With an API key of a sandbox organisation, the answer shows the extensions of that sandbox organisation.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:extensions:read

Query parameters

  • searchstring

    Shows only the extensions whose name or description holds this text. The match ignores case.

    Example:"payment"

Response

application/json

All extensions, keyed by extension ID.

  • extensionsobject

    All extensions of the platform, keyed by extension ID (for example kyc or oidc). Use the key as extensionId to turn an extension on or off.