connect

Get a connector

Changed on

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.

get/v1/connect/connectors/{connector}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/connect/connectors/{connector}
  • Auth: HTTP bearer

Path parameters

connectorstring required

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

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

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.

slugstring
Example:my-team-url-slug

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

The connector.

accentColorstring

Hex accent color (e.g., #000000) for branding.

backgroundColorstring

Hex background color (e.g., #000000) for branding.

clientUrlstring nullable

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.

connectionMethodstring

The connection method this connector was created from, when the create request named one.

createdAtnumber required

Creation time in epoch milliseconds.

creationMode'managed' | 'manual'

How the connector row was originally created. New create paths stamp this explicitly; older rows may omit it.

defaultInstallationIdstring

Installation used when a token request does not specify an installation.

devsitestring

Developer website for the connected service.

displayNamestring required

Human-readable connector name.

docsitestring

Developer documentation for the connected service.

eventsstring[]

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.

iconstring

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}.

idstring required

Stable scl_ connector ID. Use this value directly in {connector}.

knownStalefalse | true

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.

namestring required

Connector name within the owning team.

redirectUristring

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.

reinstallAtnumber

Time when this connector started requiring reinstallation because an installation-affecting app-token grant changed.

servicestring required

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.

serviceIconstring

Provider logo from the known-service registry, matched by service. Often an SVG data URL. Absent when the service is not in the registry.

supportedSubjectTypesstring[] required

Token subject types supported by the connector.

supportsIconunknown required
supportsInstallationfalse | true required

Whether the connector supports an installation flow.

supportsManagedEjectionfalse | true

Whether this managed connector can disconnect from its manager.

supportsRevocationfalse | true required

Whether Connect can revoke tokens for this connector.

supportsTriggersfalse | true required

Whether this connector type supports trigger webhooks. Derived from the type definition; indicates that triggers and triggerDestinations may be meaningful for this connector.

targetstring

Which of the service's products/surfaces this connector points at.

type'api-key' | 'aws-alpha' | 'custom' | 'discord' | 'github' | 'linear' | 'linq' | 'microsoft-entra' | 'microsoft-teams' | 'oauth' | 'photon' | 'salesforce' | 'sendblue' | 'slack' | 'snowflake' | 'snowflake-wif' | 'stripe-api-key' required

Connector implementation type.

typeIconstring

Icon identifier supplied by the connector type.

typeNamestring required

Human-readable name of the connector type.

uidstring required

Team-scoped UID. URL-encode this value before using it in {connector}.

updatedAtnumber required

Last update time in epoch milliseconds.

websitestring

Public website for the connected service.

Changes

  • 831b9cdd2d65Revision changes
    • info

      added the non-success response with the status

  • 12ef0e5c5944Revision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status