Get Workspace Connectors

get/v1/workspace-connectors/{workspace_connector_id}

Returns a single installed workspace connector by id, including its per-workspace config and current status. Read only, no side effects. Scoped to the authenticated workspace.

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

Path parameters

NameTypeRequiredDescription
workspace_connector_idstring <uuid>YesUUID of the workspace connector.e.g. 7a8b9c0d-1e2f-4304-95a6-b7c8d9e0f1a2

Request

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

Responses

200 — The workspace connector.

{
  "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"
          }
        ]
      }
    }
  }
}

401 — Missing or invalid bearer token.

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

404 — No workspace connector exists with the supplied id.

{
  "code": "NOT_FOUND",
  "status": 404,
  "title": "Not Found",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}