List connectors

curl --request GET \
  --url https://api.wellapp.ai/v1/connectors \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.wellapp.ai/v1/connectors"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.wellapp.ai/v1/connectors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wellapp.ai/v1/connectors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wellapp.ai/v1/connectors"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.wellapp.ai/v1/connectors")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wellapp.ai/v1/connectors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

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

{
  "code": "UNAUTHORIZED",
  "status": 401,
  "title": "Unauthorized",
  "message": "You are not authorized to access this resource",
  "meta": {
    "log_id": "65c669d4-679c-4a8b-b8c0-fbe37699bb5b"
  }
}

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

import requests

url = "https://api.wellapp.ai/v1/connectors"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.wellapp.ai/v1/connectors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wellapp.ai/v1/connectors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wellapp.ai/v1/connectors"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.wellapp.ai/v1/connectors")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wellapp.ai/v1/connectors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

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

{
  "code": "UNAUTHORIZED",
  "status": 401,
  "title": "Unauthorized",
  "message": "You are not authorized to access this resource",
  "meta": {
    "log_id": "65c669d4-679c-4a8b-b8c0-fbe37699bb5b"
  }
}

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:

Relationship	Cardinality	Filter on a field	Sort by a field
`workspace_connectors`	to-many (WorkspaceConnector)	`{ "workspace_connectors": { "_some": { "field_name": { "_eq": … } } } }`	aggregate proxy only ⚠️
`connector_filters`	to-many (ConnectorFilter)	`{ "connector_filters": { "_some": { "field_name": { "_eq": … } } } }`	aggregate proxy only ⚠️
`provider_connector`	to-one (ProviderConnector)	`{ "provider_connector": { "field_name": { "_eq": … } } }`	`"field": "provider_connector.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": "connectors",
  "whereClause": { "provider_connector": { "field_name": { "_ilike": "%acme%" } } },
  "orderBy": { "field": "provider_connector.field_name", "direction": "asc" }
}

Filter by a to-many relation (quantified — bare nesting is invalid):

{
  "root": "connectors",
  "whereClause": { "workspace_connectors": { "_some": { "field_name": { "_gt": 0 } } } }
}

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

Main Resources

Atomic Resources

System

Records — read endpoints

Get Connectors

Headers

Query Parameters

Response

​Filtering & sorting on related objects

Headers

Query Parameters

Response

Filtering & sorting on related objects