List Workspace Connectors

get/v1/workspace-connectors

Returns the connector instances installed in the authenticated workspace, for example the live Mercury and Gmail connections for Foldspace AI. Each row pairs a connector definition with its per-workspace config and status. Read only, cursor paginated. ## Filtering & sorting Filter via `POST /v1/records/query` (root `workspace_connectors`) or the `filters` model; operators are gated by each field's data type. See [Filtering & sorting](../filtering-and-sorting). **Filterable fields** | Field | Type | Allowed operators | |---|---|---| | `composite_accounts_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_connector_action` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_documents_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_invoices_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_journal_entries_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_journals_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_ledger_accounts_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_payment_means_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_transactions_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `created_at` | date | `eq` `lt` `gt` `is_null` `is_not_null` | | `deleted_at` | date | `eq` `lt` `gt` `is_null` `is_not_null` | | `pk` | number | `eq` `neq` `gt` `gte` `lt` `lte` `is_null` `is_not_null` | | `status` | enum | `eq` `neq` `in` `is_null` `is_not_null` | | `updated_at` | date | `eq` `lt` `gt` `is_null` `is_not_null` | | `workspace_connector_id` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | **Sortable fields:** `composite_accounts_list`, `composite_connector_action`, `composite_documents_list`, `composite_invoices_list`, `composite_journal_entries_list`, `composite_journals_list`, `composite_ledger_accounts_list`, `composite_payment_means_list`, `composite_transactions_list`, `created_at`, `deleted_at`, `pk`, `status`, `updated_at`, `workspace_connector_id` (via `orderBy` / `sort`, `asc`|`desc`).

Requires a bearer token: Authorization: Bearer <token>.

Query parameters

NameTypeRequiredDescription
cursorstringNoOpaque pagination cursor returned in links.next of a previous page. Omit to fetch the first page.e.g. eyJwayI6MzN9
limitintegerNoMaximum number of workspace connectors to return per page.e.g. 25

Request

cURL
curl -X GET https://api.wellapp.ai/v1/workspace-connectors \
  -H "Authorization: Bearer $WELL_API_TOKEN"

Responses

200 — A page of workspace connectors.

{
  "data": [
    {
      "type": "workspace_connector",
      "id": "7a8b9c0d-1e2f-4304-95a6-b7c8d9e0f1a2",
      "attributes": {
        "status": "active",
        "config": {
          "account_label": "Mercury operating"
        },
        "created_at": "2026-06-01T09:14:00.000Z",
        "updated_at": "2026-06-07T08:00:00.000Z"
      },
      "relationships": {
        "connector": {
          "data": {
            "type": "Connector",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        },
        "person": {
          "data": {
            "type": "People",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        },
        "filter": {
          "data": {
            "type": "ConnectorFilter",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        },
        "syncTargets": {
          "data": [
            {
              "type": "WorkspaceConnectorSyncTarget",
              "id": "00000000-0000-4000-8000-000000000001"
            }
          ]
        },
        "connectorMappings": {
          "data": [
            {
              "type": "ConnectorMapping",
              "id": "00000000-0000-4000-8000-000000000001"
            }
          ]
        },
        "syncDiagnostics": {
          "data": [
            {
              "type": "ConnectorSyncDiagnostic",
              "id": "00000000-0000-4000-8000-000000000001"
            }
          ]
        },
        "syncLogs": {
          "data": [
            {
              "type": "WorkspaceConnectorSyncLog",
              "id": "00000000-0000-4000-8000-000000000001"
            }
          ]
        },
        "documentWorkspaceConnectors": {
          "data": [
            {
              "type": "DocumentWorkspaceConnector",
              "id": "00000000-0000-4000-8000-000000000001"
            }
          ]
        }
      }
    },
    {
      "type": "workspace_connector",
      "id": "3b4c5d6e-7f80-4912-a3b4-c5d6e7f80912",
      "attributes": {
        "status": "active",
        "config": {
          "mailbox": "remy@foldspace.ai"
        },
        "created_at": "2026-06-02T10:20:00.000Z",
        "updated_at": "2026-06-07T08:05:00.000Z"
      },
      "relationships": {
        "connector": {
          "data": {
            "type": "Connector",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        },
        "person": {
          "data": {
            "type": "People",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        },
        "filter": {
          "data": {
            "type": "ConnectorFilter",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        },
        "syncTargets": {
          "data": [
            {
              "type": "WorkspaceConnectorSyncTarget",
              "id": "00000000-0000-4000-8000-000000000001"
            }
          ]
        },
        "connectorMappings": {
          "data": [
            {
              "type": "ConnectorMapping",
              "id": "00000000-0000-4000-8000-000000000001"
            }
          ]
        },
        "syncDiagnostics": {
          "data": [
            {
              "type": "ConnectorSyncDiagnostic",
              "id": "00000000-0000-4000-8000-000000000001"
            }
          ]
        },
        "syncLogs": {
          "data": [
            {
              "type": "WorkspaceConnectorSyncLog",
              "id": "00000000-0000-4000-8000-000000000001"
            }
          ]
        },
        "documentWorkspaceConnectors": {
          "data": [
            {
              "type": "DocumentWorkspaceConnector",
              "id": "00000000-0000-4000-8000-000000000001"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "total": 2,
    "count": 2
  },
  "links": {
    "next": null
  }
}

400 — Invalid pagination parameters.

{
  "code": "BAD_REQUEST",
  "status": 400,
  "title": "Bad Request",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

401 — Missing or invalid bearer token.

{
  "code": "UNAUTHORIZED",
  "status": 401,
  "title": "Unauthorized",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

Filtering & sorting on related objects

Filter and sort on a related (included) object by nesting into the relationship — the same relationships you pass to include.

  • To-one relations nest directly: { "issuer": { "name": { "_eq": "Acme" } } }, and sort by a dot-path: "orderBy": { "field": "issuer.name", "direction": "asc" }.
  • To-many relations must be quantified with _some, _every, or _none: { "items": { "_some": { "quantity": { "_gt": 1 } } } }. They are not directly sortable (a to-many sort needs an aggregate proxy).
  • Composite composite_* columns are virtual — filter and sort on their underlying source fields, not on the composite.

Workspace row-level security applies at every hop, so a related-object filter never widens your tenant scope. Full operator set, deep-nesting rules, and pagination notes: Filtering & sorting.

This resource's related objects (the ones you can include) and how to filter or sort on each:

RelationshipCardinalityFilter on a fieldSort by a field
connectorto-one (Connector){ "connector": { "field_name": { "_eq": … } } }"field": "connector.field_name" ✅
workspaceto-one (Workspace){ "workspace": { "field_name": { "_eq": … } } }"field": "workspace.field_name" ✅
personto-one (People){ "person": { "field_name": { "_eq": … } } }"field": "person.field_name" ✅

Replace field_name with any field of the related object. See its object-reference page for the full field list.

Filter by a to-one relation (and sort by it):

{
  "root": "workspace_connectors",
  "whereClause": { "connector": { "field_name": { "_ilike": "%acme%" } } },
  "orderBy": { "field": "connector.field_name", "direction": "asc" }
}