Skip to main content
GET
/
v1
/
connectors
List connectors
curl --request GET \
  --url https://api.wellapp.ai/v1/connectors \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "type": "connector",
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "attributes": {
        "slug": "salesforce",
        "name": "Salesforce",
        "description": "Connects to Salesforce CRM for sync.",
        "category": "crm",
        "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": "organization",
            "id": "550e8400-e29b-41d4-a716-446655440001"
          }
        },
        "logo": {
          "data": {
            "type": "media",
            "id": "550e8400-e29b-41d4-a716-446655440002"
          }
        }
      }
    },
    {
      "type": "connector",
      "id": "a1b2c3d4-58cc-4372-a567-0e02b2c3d480",
      "attributes": {
        "slug": "github",
        "name": "GitHub",
        "description": "Connects to GitHub for repository management and CI/CD.",
        "category": "ci_cd",
        "direction": "both",
        "tags": [
          "git",
          "version-control",
          "ci-cd"
        ],
        "status": "active",
        "version": "1.5.2",
        "data_quality": {
          "imported_fields": [
            "company",
            "people"
          ],
          "last_synced": "2025-06-19T15:30:00Z"
        },
        "redirect_url": "https://app.well.com/connectors/github/success",
        "state": "active",
        "created_at": "2025-09-15T08:00:00.000Z",
        "updated_at": "2025-10-01T12:00:00.000Z"
      },
      "relationships": {
        "published_by": {
          "data": {
            "type": "organization",
            "id": "550e8400-e29b-41d4-a716-446655440001"
          }
        },
        "logo": {
          "data": {
            "type": "media",
            "id": "550e8400-e29b-41d4-a716-446655440003"
          }
        }
      }
    }
  ],
  "included": [
    {
      "type": "organization",
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "attributes": {
        "name": "Well Technologies",
        "description": "Open-source data integration and financial technology platform",
        "website": "https://well.com",
        "external_id": "well_org_001"
      }
    },
    {
      "type": "media",
      "id": "550e8400-e29b-41d4-a716-446655440002",
      "attributes": {
        "file_name": "salesforce_logo.png",
        "content_type": "image/png",
        "file_size": 15420,
        "media_type": "logo",
        "upload_url": "https://storage.well.com/media/salesforce_logo.png"
      }
    },
    {
      "type": "media",
      "id": "550e8400-e29b-41d4-a716-446655440003",
      "attributes": {
        "file_name": "github_logo.png",
        "content_type": "image/png",
        "file_size": 18750,
        "media_type": "logo",
        "upload_url": "https://storage.well.com/media/github_logo.png"
      }
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "total": 2,
    "total_pages": 1
  }
}

Headers

​
Authorization
string
required

Bearer token for authentication

Query Parameters

​
include
string

Comma-separated list of related resources to include. Available options: published_by, logo, category

​
created_at_from
string<date-time>

Filter connectors created from this date (ISO 8601 format)

​
created_at_to
string<date-time>

Filter connectors created until this date (ISO 8601 format)

​
updated_at_from
string<date-time>

Filter connectors updated from this date (ISO 8601 format)

​
updated_at_to
string<date-time>

Filter connectors updated until this date (ISO 8601 format)

​
workspace_id
string<uuid>

Filter by workspace ID that published the connector

​
published_by
string<uuid>

Filter by workspace that published the connector

​
category
enum<string>

Filter by connector category. See all available categories for complete list.

Available options:
database,
data_warehouse,
other
​
direction
enum<string>

Filter by data flow direction capability

Available options:
import,
export,
both
​
status
enum<string>

Filter by connector status

Available options:
active,
inactive,
pending,
deprecated
​
name
string

Filter by connector name (partial match, case-insensitive)

​
sort
enum<string>

Sort by field. Use '-' prefix for descending order (e.g., '-created_at' for newest first)

Available options:
created_at,
-created_at,
updated_at,
-updated_at,
name,
-name,
category,
-category
​
limit
integer
default:25

Number of results to return per page

Required range: 1 <= x <= 100
​
page
integer
default:1

Page number for pagination

Required range: x >= 1

Response

Connectors retrieved successfully

​
data
object[]
​
meta
object
⌘I