VEvercel
connect

List connectors

Changed on

List connectors that belong to a team.

get/v2/connect/connectors

Request

  • Base URL
    https://api.vercel.com
  • URL
    https://api.vercel.com/v2/connect/connectors
  • Auth
    HTTP bearer

Query parameters

limitinteger

Maximum number of connectors to return. Defaults to 20.

cursorstring

Cursor from pagination.next on the previous response.

projectIdstring

Return only connectors connected to this project.

searchstring

Search connector names, UIDs, and services.

typestring

Comma-separated connector types: slack, discord, github, linear, linq, salesforce, sendblue, snowflake, snowflake-wif, microsoft-entra, api-key, photon, oauth, or custom.

servicestring

Comma-separated provider or service identifiers.

sort'name' | 'createdAt' | 'updatedAt'

Sort by name in ascending order, or by creation or update time in descending order.

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

A page of connectors.

Changes

  • 1f3e348952c9Revision changes
    • warning

      added the new aws-oidc enum value to the // response property for the response status

    • info

      removed the aws-alpha enum value from the // response property for the response status

  • 7c4766bd54abRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status