Skip to content
Docs

Get a connector

GEThttps://api.vercel.com/v1/connect/connectors/{connector}
Get the connector by ID. Accepts a dashboard/team requester or a deployment's project OIDC token; project requesters may only read connectors linked to their project and environment.
Request
import { Vercel } from "@vercel/sdk";


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


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


  console.log(result);
}


run();
Response
{
  "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"
}
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

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.
accentColorstringOptional
Hex accent color (e.g., #000000) for branding.
appTokensobjectOptional
App-token capabilities and known grants for the connector.
backgroundColorstringOptional
Hex background color (e.g., #000000) for branding.
clientUrlstringOptional
Provider-side URL for viewing or managing the resource represented by the connector. The destination can be an app, account, phone line, or service instance, depending on the connector type.
connectionMethodstringOptional
The connection method this connector was created from, when the create request named one.
createdAtnumberRequired
Creation time in epoch milliseconds.
createdByobjectOptional2 variants
creationModestringOptional
How the connector row was originally created. New create paths stamp this explicitly; older rows may omit it.
defaultInstallationIdstringOptional
Installation used when a token request does not specify an installation.
devsitestringOptional
Developer website for the connected service.
displayNamestringRequired
Human-readable connector name.
docsitestringOptional
Developer documentation for the connected service.
eventsarrayOptional
Known events this connector subscribes to (e.g. Slack bot events, GitHub webhook events). Names are type-specific and validated by the managed-create flow when forwarded to the third-party service.
iconstringOptional
Connector branding icon. SHA-1 hash that resolves to the uploaded icon through the Vercel avatar service. Consumers render this with https://vercel.com/api/www/avatar/{icon}.
idstringRequired
Stable scl_ connector ID. Use this value directly in {connector}.
knownStalebooleanOptional
Whether the connector is known to have been edited since the app package it publishes to the provider was last built, so that package no longer matches it. Absent when it was not computed, or when the connector type publishes no such package. Derived on every read rather than marked at edit time, so reverting an edit clears it. Only reported by connector types that publish a package a user has to re-publish by hand — Microsoft Teams today.
managedobjectOptional
Managed connector metadata exposed without leaking the manager connector or installation identifiers.
namestringRequired
Connector name within the owning team.
redirectUristringOptional
Redirect URI registered with the third-party service for this connector, if any. Used by startAuthorization/startInstallation to replay the exact URI back to the provider's token endpoint. Absent on connectors created before this field was introduced; those callers fall back to the https://connect.vercel.com/callback default.
reinstallAtnumberOptional
Time when this connector started requiring reinstallation because an installation-affecting app-token grant changed.
servicestringRequired
Best-effort identifier of the third-party service this connector represents, independent of type. Examples: 'slack', 'mcp.linear.app', and 'auth.example.com'. Always present in API responses.
serviceIconstringOptional
Provider logo from the known-service registry, matched by service. Often an SVG data URL. Absent when the service is not in the registry.
supportedSubjectTypesarrayRequired
Token subject types supported by the connector.
supportsIconobjectRequired
Whether the connector icon can propagate to the provider.
supportsInstallationbooleanRequired
Whether the connector supports an installation flow.
supportsManagedEjectionbooleanOptional
Whether this managed connector can disconnect from its manager.
supportsRevocationbooleanRequired
Whether Connect can revoke tokens for this connector.
supportsTriggersbooleanRequired
Whether this connector type supports trigger webhooks. Derived from the type definition; indicates that triggers and triggerDestinations may be meaningful for this connector.
targetstringOptional
Which of the service's products/surfaces this connector points at.
triggerDestinationsarrayOptional
Destinations that incoming triggers should be forwarded to. Limited to 3 entries. Set the initial destination with triggerDestination during creation. Replace the complete set with PATCH /v1/connect/connectors/{connector}/trigger-destinations.
triggersobjectOptional
Incoming trigger configuration. Only present when enabled.
typestringRequired
Connector implementation type.
typeIconstringOptional
Icon identifier supplied by the connector type.
typeNamestringRequired
Human-readable name of the connector type.
uidstringRequired
Team-scoped UID. URL-encode this value before using it in {connector}.
updatedAtnumberRequired
Last update time in epoch milliseconds.
updatedByobjectOptional2 variants
userTokensobjectOptional
User-token capabilities and known grants for the connector.
websitestringOptional
Public website for the connected service.

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.
422The request cannot be completed in the current state.
errorobjectRequired
Error details.
501Error
504Error