Skip to content
Docs

Get a connector project connection

GEThttps://api.vercel.com/v1/connect/connectors/{connector}/projects/{projectId}
Get the configuration that connects a connector to a project.
Request
import { Vercel } from "@vercel/sdk";


const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.connect.getConnectorProjectConnection({
    connector: "<value>",
    projectId: "<id>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
{
  "connectorId": "example_id",
  "createdAt": "123",
  "enabledEnvironments": [],
  "project": {
    "customEnvironments": [
      {
        "id": "icfg_1234567890",
        "slug": "string"
      }
    ],
    "id": "icfg_1234567890",
    "name": "Example Name"
  },
  "updatedAt": "123"
}
Errors
{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

connectorstringRequired
Stable connector ID or URL-encoded team-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot.
projectIdstringRequired
Vercel project ID.

Query parameters

teamIdstringOptional
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.
slugstringOptional
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.

Response

200The connector project connection.
connectorIdstringRequired
Stable scl_ connector ID, even when the request used a UID.
createdAtnumberRequired
Time when the project connection was created, in epoch milliseconds.
enabledEnvironmentsarrayRequired
Environments where the connector is enabled for the project.
projectobjectRequired
Vercel project connected to the connector.
updatedAtnumberRequired
Time when the project connection was last updated, in epoch milliseconds.

Errors

400One of the provided values in the request query is invalid.
errorobjectRequired
Error details.
401The request is not authorized.
errorobjectRequired
Error details.
403You do not have permission to access this resource.
errorobjectRequired
Error details.
404The requested resource was not found.
errorobjectRequired
Error details.
409The request conflicts with the current resource state.
errorobjectRequired
Error details.
410The requested resource is no longer available.
errorobjectRequired
Error details.