---
title: "List live export connectors"
method: GET
path: "/v1/live-export/connectors"
tags: ["Live Exports"]
---

# List live export connectors

`GET /v1/live-export/connectors`

## Request

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

The connectors usable on the Live Export surface, with the roles each can play. A separate registry from `GET /v1/sync/connectors`: the same brand may exist on both surfaces with different auth. The `type` slugs share one namespace — the same slug always means the same brand.

## Response `200`

All live export connectors, by name.

- LiveExportConnectorList
  - `data` LiveExportConnector[], required
    - `type` string, required: The slug to pass as a side's `connector`.
    - `name` string, required
    - `roles` LiveExportConnectorRoles, required
      - `source` boolean, required: Usable as the app records are read from.
      - `destination` boolean, required: Usable as the app tables are written into.
    - `auth` LiveExportConnectorAuth, required
      - `method` 'oauth' | 'api_key', required: `oauth` connects in the browser (a person signs in; the export carries a pending action). `api_key` may also take `auth` inline at create.
      - `fields` LiveExportCredentialField[], nullable, required: The credential fields for `api_key` connectors; null for `oauth`.
        - `id` string, required: The key to use for this field inside `auth`.
        - `label` string, required
        - `optional` boolean, required: Whether the field may be omitted.
        - `placeholder` string, nullable, required: Example or hint text for the value.
    - `available` boolean, required: False when the connector needs a higher plan (see `required_plan`).
    - `required_plan` string, nullable, required: The plan that unlocks it, when `available` is false.

## 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)
