Skip to content
Docs

List connectors for a project

GEThttps://api.vercel.com/v2/connect/projects/{projectId}/connectors
List the connectors connected to a project and the environments where each connection is available.
Request
import { Vercel } from "@vercel/sdk";


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


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


  console.log(result);
}


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

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

projectIdstringRequired
Vercel project ID.

Query parameters

limitintegerOptional
Maximum number of connector connections to return. Defaults to 50.
cursorstringOptional
Cursor from pagination.next on the previous response.
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

200A page of connector connections for the project.
connectorsarrayRequired
Connector connections in this page.

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.
410The requested resource is no longer available.
errorobjectRequired
Error details.