GEgetmembrane
Integrations

Get integration by selector (id, uuid, or key)

get/integrations/{idOrKey}

Request

  • Base URL
    https://api.getmembrane.com
  • URL
    https://api.getmembrane.com/integrations/{idOrKey}
  • Auth
    HTTP bearer

Path parameters

idOrKeystring required

Query parameters

includeSecretsboolean required

Response

idstring
namestring required

Display name. Always present in API responses (filled by API if not set on create).

uuidstring

Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.

keystring

Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.

descriptionstring

Optional human-readable description.

metaobject

Optional key-value metadata.

state'BUILDING' | 'CLIENT_ACTION_REQUIRED' | 'CONFIGURATION_ERROR' | 'SETUP_FAILED' | 'READY' | 'DISCONNECTING'

Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.

revisionstring

Opaque revision token; changes on each update. Used for optimistic concurrency.

createdAtstring

ISO date when the element was created.

updatedAtstring

ISO date when the element was last updated.

archivedAtstring
isDeactivatedboolean
isReadOnlyboolean

When true, the element cannot be modified (e.g. published package elements or elements from another workspace).

logoUristring
connectorIdstring
connectorVersionstring
oAuthCallbackUristring
parametersobject
hasMissingParametersboolean
hasDocumentationboolean
hasOperationsboolean
operationsCountnumber
hasDataboolean
dataCollectionsCountnumber
hasEventsboolean
eventsCountnumber
hasGlobalWebhooksboolean
hasUdmboolean
isTestboolean
externalAppIdstring
authType'integration-app-token' | 'membrane-token' | 'oauth2' | 'oauth1' | 'client-credentials' | 'proxy'
optionsConfigobject
specobject
appUristring
isConnectedboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.