Get connection status

connectionStatus(projectReference: ID!, name: String!, scope: ConnectionScope!): ConnectionStatus!

Requires project.integrations.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceID!YesProject ID or slug. A missing or inaccessible project, including a denied scope-dependent project access check, returns not_found.
nameString!YesIntegration name, for example github.
scopeConnectionScope!YesConnection owner to inspect. Requires viewer access to the project. API keys never see user-scope connections. Verified user-session or API-key credentials are required; MCP OAuth grants and runtime credentials are refused.

Response

Returns ConnectionStatus!. Open the type for its fields and nested types.

FieldTypeDescription
integrationString!Integration name that was checked.
scopeConnectionScope!
connectedBoolean!True when a usable connection exists for this owner.
connectionIdIDID of the current connection; null when connected is false.
connectionGenerationIdIDGeneration of the current connection; null when connected is false.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query ConnectionStatus($projectReference: ID!, $name: String!, $scope: ConnectionScope!) {
  connectionStatus(projectReference: $projectReference, name: $name, scope: $scope) {
    connected
    connectionGenerationId
    connectionId
    integration
    scope
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "name": "example",
  "scope": "user"
}