Skip to main content
GET
Get connection status

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project ID or slug. A missing or inaccessible project, including a denied scope-dependent project access check, returns not_found.

Minimum string length: 1
name
string
required

Integration name, for example github or slack.

Minimum string length: 1

Query Parameters

scope
enum<string>
required

Connection 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.

Available options:
user,
project

Response

Connection availability and current IDs; disconnected owners have null IDs.

integration
string
required

Integration name that was checked.

scope
enum<string>
required

Connection owner: user for your own connection in the project, project for the shared one.

Available options:
user,
project
connected
boolean
required

True when a usable connection exists for this owner.

connection_id
string<uuid> | null
required

ID of the current connection; null when connected is false. Pass it to delete_connection.

connection_generation_id
string<uuid> | null
required

Generation of the current connection; null when connected is false.