---
title: get-a-connector-project-connection
product: vercel
url: /docs/rest-api/connect/get-a-connector-project-connection
canonical_url: "https://vercel.com/docs/rest-api/connect/get-a-connector-project-connection"
last_updated: 2026-09-02
type: reference
prerequisites:
  []
related:
  - /docs/rest-api
summary: Learn about get-a-connector-project-connection on Vercel.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# Get a connector project connection

```http
GET /v1/connect/connectors/{connector}/projects/{projectId}
```

Get the configuration that connects a connector to a project.

## Authentication

**bearerToken**: HTTP bearer

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `connector` | string | Yes | Stable connector ID or URL-encoded team-scoped UID. Examples: `scl_abc123` or `slack%2Fmy-bot`. |
| `projectId` | string | Yes | Vercel project ID. |


## Query parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `teamId` | string | No | The team ID that scopes the request. Do not send it with slug. If both are omitted, Vercel uses the team associated with the token or the authenticated user's default team. The request returns 401 if no team can be selected. |
| `slug` | string | No | The team slug that scopes the request. Do not send it with teamId. If both are omitted, Vercel uses the team associated with the token or the authenticated user's default team. The request returns 401 if no team can be selected. |


## Example request

### TypeScript

```typescript
const response = await fetch('https://api.vercel.com/v1/connect/connectors/connector/projects/projectId?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
```

### Next.js

```typescript
'use server';

export async function callEndpoint() {
  const response = await fetch('https://api.vercel.com/v1/connect/connectors/connector/projects/projectId?teamId=string&slug=string', {
    method: 'GET',
    headers: {
      'Authorization': `Bearer ${process.env.VERCEL_ACCESS_TOKEN}`,
      'Content-Type': 'application/json',
    },
    next: { revalidate: 3600 }
  });

  if (!response.ok) {
    throw new Error('Request failed');
  }

  return response.json();
}
```

### cURL

```bash
curl -X GET 'https://api.vercel.com/v1/connect/connectors/connector/projects/projectId?teamId=string&slug=string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
```

## Example response

```json
{
  "connectorId": "example_id",
  "project": {
    "id": "icfg_1234567890",
    "name": "Example Name",
    "customEnvironments": [
      {
        "id": "icfg_1234567890",
        "slug": "string"
      }
    ]
  },
  "enabledEnvironments": [],
  "createdAt": "123",
  "updatedAt": "123"
}
```

## Responses

### 200: The connector project connection.

Content-Type: `application/json`

```json
{
  "type": "object",
  "description": "A connection between a connector and a Vercel project, including the environments where the connector is enabled.",
  "required": [
    "connectorId",
    "createdAt",
    "enabledEnvironments",
    "project",
    "updatedAt"
  ],
  "properties": {
    "connectorId": {
      "type": "string",
      "description": "Stable `scl_` connector ID, even when the request used a UID."
    },
    "project": {
      "type": "object",
      "description": "Vercel project connected to the connector.",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Same Vercel project ID as the connection's top-level `projectId`."
        },
        "name": {
          "type": "string",
          "description": "Current Vercel project name."
        },
        "customEnvironments": {
          "type": "array",
          "description": "Custom environments available on the project. This list can include environments where the connector is not enabled.",
          "items": {
            "type": "object",
            "description": "Custom environments available on the project. This list can include environments where the connector is not enabled.",
            "required": [
              "id",
              "slug"
            ]
          }
        }
      }
    },
    "enabledEnvironments": {
      "type": "array",
      "description": "Environments where the connector is enabled for the project.",
      "items": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "string",
            "enum": [
              "development",
              "preview",
              "production"
            ]
          }
        ]
      }
    },
    "createdAt": {
      "type": "number",
      "description": "Time when the project connection was created, in epoch milliseconds."
    },
    "updatedAt": {
      "type": "number",
      "description": "Time when the project connection was last updated, in epoch milliseconds."
    }
  }
}
```

### 400: One of the provided values in the request query is invalid.

Content-Type: `application/json`

```json
{
  "type": "object",
  "description": "Error response returned by a Connect API operation.",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "description": "Error details.",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "description": "Stable machine-readable error code."
        },
        "message": {
          "type": "string",
          "description": "Human-readable error message."
        }
      },
      "additionalProperties": true
    }
  }
}
```

### 401: The request is not authorized.

Content-Type: `application/json`

```json
{
  "type": "object",
  "description": "Error response returned by a Connect API operation.",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "description": "Error details.",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "description": "Stable machine-readable error code."
        },
        "message": {
          "type": "string",
          "description": "Human-readable error message."
        }
      },
      "additionalProperties": true
    }
  }
}
```

### 403: You do not have permission to access this resource.

Content-Type: `application/json`

```json
{
  "type": "object",
  "description": "Error response returned by a Connect API operation.",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "description": "Error details.",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "description": "Stable machine-readable error code."
        },
        "message": {
          "type": "string",
          "description": "Human-readable error message."
        }
      },
      "additionalProperties": true
    }
  }
}
```

### 404: The requested resource was not found.

Content-Type: `application/json`

```json
{
  "type": "object",
  "description": "Error response returned by a Connect API operation.",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "description": "Error details.",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "description": "Stable machine-readable error code."
        },
        "message": {
          "type": "string",
          "description": "Human-readable error message."
        }
      },
      "additionalProperties": true
    }
  }
}
```

### 410: The requested resource is no longer available.

Content-Type: `application/json`

```json
{
  "type": "object",
  "description": "Error response returned by a Connect API operation.",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "type": "object",
      "description": "Error details.",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "description": "Stable machine-readable error code."
        },
        "message": {
          "type": "string",
          "description": "Human-readable error message."
        }
      },
      "additionalProperties": true
    }
  }
}
```

---

## Related

- [connect endpoints](/docs/rest-api#connect)

- [REST API overview](/docs/rest-api)

- [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints)

---

[View full sitemap](/docs/sitemap)