Get Connectors by id

get/v1/connectors/{connector_id}

Retrieve a specific connector by its unique identifier. This endpoint supports: **Include functionality**: Use the `include` parameter to get detailed relationship data including organization, category, and media information. **Relationship data**: Returns complete connector information with all attributes and relationships.

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

Path parameters

Name	Type	Required	Description
connector_id	string <uuid>	Yes	The unique identifier of the connector to retrievee.g. 550e8400-e29b-41d4-a716-446655440000

Query parameters

Name	Type	Required	Description
include	string	No	Include related resources in the response. Multiple values can be comma-separated.e.g. Include

Request

cURL

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

Responses

200 — Connector retrieved successfully

{
  "type": "connector",
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "attributes": {
    "slug": "salesforce",
    "name": "Salesforce",
    "description": "Connects to Salesforce CRM for sync.",
    "category": "api",
    "direction": "import",
    "tags": [
      "crm",
      "cloud",
      "sync"
    ],
    "status": "active",
    "version": "2.1.0",
    "data_quality": {
      "imported_fields": [
        "invoice",
        "company",
        "people"
      ],
      "last_synced": "2025-06-20T09:00:00Z"
    },
    "redirect_url": "https://app.well.com/connectors/salesforce/success",
    "state": "active",
    "created_at": "2025-10-07T14:30:00.000Z",
    "updated_at": "2025-10-07T14:30:00.000Z"
  },
  "relationships": {
    "published_by": {
      "data": {
        "type": "workspace",
        "id": "airbyte"
      }
    },
    "logo": {
      "data": {
        "type": "media",
        "id": "550e8400-e29b-41d4-a716-446655440010"
      }
    }
  },
  "included": [
    {
      "type": "workspace",
      "id": "airbyte",
      "attributes": {
        "name": "Airbyte",
        "description": "Open-source data integration platform",
        "website": "https://airbyte.com"
      },
      "relationships": {
        "connector_filters": {
          "data": [
            {
              "type": "ConnectorFilter",
              "id": "00000000-0000-4000-8000-000000000001"
            }
          ]
        },
        "provider_connector": {
          "data": {
            "type": "ProviderConnector",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        }
      }
    },
    {
      "type": "media",
      "id": "550e8400-e29b-41d4-a716-446655440010",
      "attributes": {
        "file_name": "salesforce_logo.png",
        "content_type": "image/png",
        "file_size": 12345
      },
      "relationships": {
        "connector_filters": {
          "data": [
            {
              "type": "ConnectorFilter",
              "id": "00000000-0000-4000-8000-000000000001"
            }
          ]
        },
        "provider_connector": {
          "data": {
            "type": "ProviderConnector",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        }
      }
    }
  ]
}

400 — Bad request - invalid query parameters

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

401 — Unauthorized - invalid API key

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