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
  }
}

Connectors

Get Connectors

Retrieve a list of connector records with advanced filtering, sorting, and include capabilities. This endpoint supports:

Default behavior: Returns all connectors associated with the workspace_id and organization extracted from the authentication token.

Include functionality: Use the include parameter to get full details of related resources in the response.

Date filtering: Filter by creation or update date ranges using created_at_from/to and updated_at_from/to.

Relationship filtering: Filter by related entities using workspace_id, published_by, etc.

Category filtering: Filter by connector categories like crm, api, database, etc.

Status filtering: Filter by connector status and data synchronization state.

Sorting: Sort results by created_at, updated_at, name, or category in ascending or descending order.

GET

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

Response

Connectors retrieved successfully

data

object[]

Show child attributes

data.type

string

Allowed value: "connector"

data.id

string<uuid>

UUID of the connector

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.attributes

object

Show child attributes

data.attributes.slug

string

Connector slug used in URLs (system generated if not provided)

Maximum string length: 255

Example:

"salesforce"

data.attributes.name

string

Connector name

Maximum string length: 255

Example:

"Salesforce"

data.attributes.description

string

Description of the connector

Maximum string length: 1000

Example:

"Connects to Salesforce CRM for sync."

data.attributes.category

enum<string>

Integration category. See all available categories for complete list.

Available options:

database,

...

Example:

"api"

data.attributes.direction

enum<string>

Data flow direction capability

Available options:

import,

export,

both

Example:

"import"

data.attributes.tags

string[]

Grouping/search tags

Example:

["crm", "cloud", "sync"]

data.attributes.data_quality

object

Show child attributes

data.attributes.data_quality.imported_fields

enum<string>[]

Category connector. See all available categories for complete list.

Available options:

invoice,

company,

people

Example:

["invoice", "company", "people"]

data.attributes.data_quality.last_synced

string<date-time>

Timestamp of last sync

Example:

"2025-06-20T09:00:00Z"

data.attributes.redirect_url

string<uri>

URL to redirect customers after onboarding flow

Example:

"https://app.well.com/connectors/salesforce/success"

data.attributes.state

string

State included in the redirect URL

Example:

"active"

data.attributes.status

enum<string>

Lifecycle status (system managed)

Available options:

active,

beta,

deprecated

Example:

"active"

data.attributes.created_at

string<date-time>

Creation timestamp

Example:

"2025-10-07T14:30:00.000Z"

data.attributes.updated_at

string<date-time>

Last update timestamp

Example:

"2025-10-07T14:30:00.000Z"

data.relationships

object

Show child attributes

data.relationships.published_by

object

Show child attributes

data.relationships.published_by.data

object

Show child attributes

data.relationships.published_by.data.type

string

Allowed value: "workspace"

data.relationships.published_by.data.id

string<uuid>

UUID of the workspace that published this connector

Example:

"550e8400-e29b-41d4-a716-446655440001"

data.relationships.logo

object

Show child attributes

data.relationships.logo.data

object

Show child attributes

data.relationships.logo.data.type

string

Allowed value: "media"

data.relationships.logo.data.id

string<uuid>

UUID of the logo media

Example:

"550e8400-e29b-41d4-a716-446655440010"

data.included

object

Object containing included resources referenced in relationships, organized by resource type. These are the actual created/linked resources with real UUIDs.

Show child attributes

data.included.published_by

object

Workspaces associated with this company

Show child attributes

data.included.published_by.data

object[]

Show child attributes

data.included.published_by.data.type

string

Allowed value: "workspace"

data.included.published_by.data.id

string<uuid>

UUID of the workspace

data.included.published_by.data.attributes

object

Show child attributes

data.included.published_by.data.attributes.name

string

required

Workspace name

Required string length: 1 - 255

data.included.published_by.data.attributes.description

string

Workspace description

Maximum string length: 1000

data.included.published_by.data.attributes.avatar_color

string

Avatar color in hexadecimal format (e.g., #FF5733)

data.included.published_by.data.attributes.external_workspace_id

string

External workspace identifier

Required string length: 1 - 255

data.included.media

object

Media files associated with this company

Show child attributes

data.included.media.data

object[]

Show child attributes

data.included.media.data.type

string

Allowed value: "media"

data.included.media.data.id

string<uuid>

UUID of the media

data.included.media.data.attributes

object

Show child attributes

data.included.media.data.attributes.media_type

enum<string>

Available options:

avatar,

logo,

banner

data.included.media.data.attributes.url

string<uri>

URL to the media file

data.included.media.data.attributes.is_primary

boolean

Whether this is the primary media

data.included.media.data.attributes.processed_at

string<date-time>

Timestamp when media processing completed

data.included.media.data.attributes.uploaded_at

string<date-time>

Main Resources

Atomic Resources

System

Get Connectors

Headers

Query Parameters

Response