List global integrators with tenant activation status Get every global integrator alongside its activation…

GET /api/configuration/operator/integrators

Success: 200 OK

Products: Operator (FOH)
Features: Front of House Generic Access (FOHGENERIC)

Overview

Returns the catalogue of Gladstone-curated global integrators, each annotated with whether your own tenant has an active API key for it. Use it to render an integrations catalogue and to decide, per integrator, whether the next action is to activate it or to leave it alone.

The full set is returned every time — every global integrator, whether or not your tenant uses it, whether or not the integrator itself is enabled — sorted by name. There is no paging, filtering or search. Your tenant's own integrators are not in this list; read those from List the current tenant's private integrators.

No plaintext API key is ever returned here. Only the 8-character prefix appears, and only when your tenant holds an active key. The plaintext is shown exactly once, in the response to Activate a global integrator.

Endpoint

GET {base_url}/api/configuration/operator/integrators

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Sample request

cURL

curl -X GET '{base_url}/api/configuration/operator/integrators' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Response fields

Field	Type	Description
`[].id`	integer (int32)	The integrator's identifier. Pass it as the path `id` to Activate a global integrator; it is the only handle on the record.
`[].name`	string	The integrator's display name, set by Gladstone Support. The list is sorted by this value. It is not unique, so do not key off it.
`[].description`	string	The integrator's description, set by Gladstone Support. Null when none was given.
`[].origin`	string	The one web origin this integrator is allowed to call from. If you send an `Origin` header when requesting a token with a key from this integrator, it must match this value or the token request is rejected. You cannot change it — ask Gladstone Support.
`[].logoUrl`	string	Absolute URL of the integrator's logo, for rendering a catalogue tile. Null when none was set.
`[].isActive`	boolean	Whether the integrator record itself is enabled platform-wide, which is independent of your tenant — inactive integrators are still listed. Do not confuse it with `isActivatedForTenant`. Activating an integrator that is `false` here turns it back on.
`[].isActivatedForTenant`	boolean	Whether your tenant currently holds a usable key for this integrator. It is derived by the platform: it is `true` exactly when `activeKeyPrefix` is non-null, meaning a key exists for your environment whose status is Active and which has not passed its expiry. The two fields never disagree.
`[].activeKeyPrefix`	string	The first 8 characters of your tenant's active key for this integrator — enough to tell which key a deployed system is holding, and nothing more. Null when your tenant has no active, unexpired key. Never the full key.

Sample response

200 OK

[
  {
    "id": 12345,
    "name": "string",
    "description": "string",
    "origin": "string",
    "logoUrl": "string",
    "isActive": true,
    "isActivatedForTenant": true,
    "activeKeyPrefix": "string"
  }
]

Errors

Status	Meaning	When
`400`	Bad request	The tenant environment could not be resolved from your token, so activation status cannot be worked out. The body is the plain string `Could not resolve tenant environment.`
`500`	Internal server error	An unexpected server-side failure while reading the catalogue. The body is empty.
`503`	Service unavailable	Not returned by this endpoint itself. A `503` reaching you comes from the hosting platform in front of it.

This page as markdown · All pages · llms.txt