Skip to content
Docs

List connectors

GEThttps://api.vercel.com/v2/connect/connectors
List connectors that belong to a team.
Request
import { Vercel } from "@vercel/sdk";


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


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


  console.log(result);
}


run();
Response
{
  "connectors": [
    {
      "accentColor": "string",
      "appTokens": {
        "crossInstallation": "false",
        "permissionsUrl": "https://example.com",
        "requiresReinstallation": "false",
        "scopes": [],
        "supportedAuthorizationDetails": [],
        "supportsRefinement": "false",
        "supportsResources": "false"
      },
      "backgroundColor": "string",
      "clientUrl": "https://example.com",
      "connectionMethod": "string",
      "createdAt": "123",
      "createdBy": {
        "id": "icfg_1234567890",
        "type": "user"
      },
      "creationMode": "managed",
      "defaultInstallationId": "example_id",
      "devsite": "string",
      "displayName": "Example Name",
      "docsite": "string",
      "events": [],
      "icon": "string",
      "id": "icfg_1234567890",
      "knownStale": "false",
      "managed": {
        "sync": "false"
      },
      "name": "Example Name",
      "redirectUri": "https://example.com",
      "reinstallAt": "123",
      "service": "string",
      "serviceIcon": "string",
      "supportedSubjectTypes": [],
      "supportsIcon": "false",
      "supportsInstallation": "false",
      "supportsManagedEjection": "false",
      "supportsRevocation": "false",
      "supportsTriggers": "false",
      "target": "string",
      "triggerDestinations": [
        {
          "branch": "string",
          "customEnvironmentId": "example_id",
          "path": "string",
          "projectId": "example_id"
        }
      ],
      "triggers": {
        "enabled": "false"
      },
      "type": "api-key",
      "typeIcon": "string",
      "typeName": "Example Name",
      "uid": "example_id",
      "updatedAt": "123",
      "updatedBy": {
        "id": "icfg_1234567890",
        "type": "user"
      },
      "userTokens": {
        "crossInstallation": "false",
        "manualCredentialInput": "false",
        "scopes": [],
        "supportedAuthorizationDetails": [],
        "supportsRefinement": "false",
        "supportsResources": "false"
      },
      "website": "string"
    }
  ],
  "pagination": {
    "next": "string"
  }
}
Errors
{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

limitintegerOptional
Maximum number of connectors to return. Defaults to 20.
cursorstringOptional
Cursor from pagination.next on the previous response.
projectIdstringOptional
Return only connectors connected to this project.
typestringOptional
Comma-separated connector types: slack, discord, github, linear, linq, salesforce, sendblue, snowflake, snowflake-wif, microsoft-entra, api-key, photon, oauth, or custom.
servicestringOptional
Comma-separated provider or service identifiers.
sortstringOptional
Sort by name in ascending order, or by creation or update time in descending order.
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 connectors.
connectorsarrayRequired
Connectors 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.
404Error
errorobjectRequired
Error details.
409Error
errorobjectRequired
Error details.
410The requested resource is no longer available.
errorobjectRequired
Error details.
422The request cannot be completed in the current state.
errorobjectRequired
Error details.
501Error
504Error