Skip to content
Docs

List projects for a connector

GEThttps://api.vercel.com/v2/connect/connectors/{connector}/projects
List the projects connected to a connector and the environments where each connection is available.
https://api.vercel.com/v2/connect/connectors/{connector}/projects
const response = await fetch('https://api.vercel.com/v2/connect/connectors/connector/projects?limit=123&cursor=string&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});


const data = await response.json();
console.log(data);
Response
{
  "pagination": {
    "next": "string"
  },
  "projects": [
    {
      "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.

Query parameters

limitintegerOptional
Maximum number of project 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 project connections for the connector.
projectsarrayRequired
Project 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.
409The request conflicts with the current resource state.
errorobjectRequired
Error details.
410The requested resource is no longer available.
errorobjectRequired
Error details.