> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get connection status

> Return connection status.

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

Requires project.integrations.read.

## Arguments

| Argument | Type | Required | Description |
| - | - | - | - |
| `projectReference` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Yes | Project ID or slug. A missing or inaccessible project, including a denied scope-dependent project access check, returns not\_found. |
| `name` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Yes | Integration name, for example github. |
| `scope` | [`ConnectionScope!`](https://veryfront.com/docs/cloud/graphql/types/connectionscope) | Yes | 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. |

## Response

Returns [`ConnectionStatus!`](https://veryfront.com/docs/cloud/graphql/types/connectionstatus). Open the type for its fields and nested types.

| Field | Type | Description |
| - | - | - |
| `integration` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Integration name that was checked. |
| `scope` | [`ConnectionScope!`](https://veryfront.com/docs/cloud/graphql/types/connectionscope) | |
| `connected` | [`Boolean!`](https://veryfront.com/docs/cloud/graphql/types/boolean) | True when a usable connection exists for this owner. |
| `connectionId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | ID of the current connection; null when connected is false. |
| `connectionGenerationId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | Generation of the current connection; null when connected is false. |

Types marked with `!` cannot be null. Lists use `[Type]` notation. The [type index](https://veryfront.com/docs/cloud/graphql/schema.md) lists all published input and response types.

## Example

```graphql title="query.graphql" theme={null}
query ConnectionStatus($projectReference: ID!, $name: String!, $scope: ConnectionScope!) {
  connectionStatus(projectReference: $projectReference, name: $name, scope: $scope) {
    connected
    connectionGenerationId
    connectionId
    integration
    scope
  }
}
```

```json title="variables.json" theme={null}
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "name": "example",
  "scope": "user"
}
```

<details>
  <summary>Try this query</summary>

  Calls use `https://api.veryfront.com/graphql`. Replace sample values with resources you can access. See [Authentication](https://veryfront.com/docs/cloud/authentication.md) for credentials and permissions.

  Bearer token or API key

  Stored in this tab's session. Clear credential

  Query

  Variables (JSON)
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.