---
title: "List connectors"
method: GET
path: "/v1/sync/connectors"
tags: ["Connectors"]
---

# List connectors

`GET /v1/sync/connectors`

## Request

- Base URL: `https://api.whalesync.com`
- URL: `https://api.whalesync.com/v1/sync/connectors`
- Auth: HTTP bearer

Every connector, with its auth method and capabilities. Connectors above your plan are listed with `available: false` and the plan that unlocks them.

## Response `200`

All connectors, by name.

- ConnectorList
  - `data` Connector[], required
    - `type` string, required: The slug to pass as a side's `connector`.
    - `name` string, required
    - `auth` ConnectorAuth, required
      - `method` 'oauth' | 'api_key', required
      - `fields` ConnectorCredentialField[], nullable, required: Credential fields for `api_key`.
        - `id` string, required: The key to send under the side's `auth`, exactly as given — connectors declare their own ids.
        - `label` string, required
        - `optional` boolean, required: When false, the field is required.
        - `placeholder` string, required
        - `options` ConnectorCredentialFieldOption[], nullable, required: Valid values, if fixed.
          - `label` string, required
          - `value` string, required
        - `help` ConnectorCredentialFieldHelp, required
          - `label` string, required
          - `url` string, uri, required
    - `capabilities` ConnectorCapabilities, required
      - `read` boolean, required
      - `write` boolean, required
      - `create_tables` boolean, required: Whether the connector can create destination tables.
      - `create_fields` boolean, required: Whether the connector can create destination fields.
      - `webhooks` boolean, required: Whether the connector can receive real-time change webhooks.
    - `available` boolean, required: Whether the caller's plan includes this connector.
    - `required_plan` string, nullable, required: The plan that unlocks this connector when unavailable.

## Other responses

- `401`: The API key is missing, invalid, or revoked (`missing_api_key`, `invalid_api_key`). Carries a `required_action` linking a person to key creation, naming the smallest scope this endpoint needs.
- `403`: The key's scope does not allow this call (`insufficient_scope` on a mutation with a `read` key).
- `429`: Rate limit exceeded. Wait for `Retry-After` seconds.

---

[API](https://skmtc.dev/whalesync/apis/whalesync-api.md) · [All operations](https://skmtc.dev/whalesync/apis/whalesync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whalesync/apis/whalesync-api/revisions/5131522b325a?raw)