curl --request GET \
--url http://localhost:8080/v1/custom-connectorsimport requests
url = "http://localhost:8080/v1/custom-connectors"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8080/v1/custom-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_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/v1/custom-connectors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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 := "http://localhost:8080/v1/custom-connectors"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/v1/custom-connectors")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/v1/custom-connectors")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"connector_id": "c0ffee01-1234-5678-90ab-cdef01234567",
"name": "Acme CRM",
"source_name": "acme-crm",
"created_at": "<string>",
"created_by": {
"type": "user",
"id": "u_01abc123"
},
"is_active": true,
"table_name": "custom_acme_crm",
"accepted_kinds": [
"email",
"page"
],
"metadata": {
"env": "staging"
}
}
]{
"error_code": "authentication_error",
"message": "Invalid or missing credentials.",
"details": {}
}{
"error_code": "permission_denied",
"message": "You do not have permission to perform this action.",
"details": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error_code": "internal_server_error",
"message": "An unexpected error occurred.",
"details": {}
}List custom connectors
List custom connectors for the calling workspace. Set include_inactive=true
to include deactivated connectors.
curl --request GET \
--url http://localhost:8080/v1/custom-connectorsimport requests
url = "http://localhost:8080/v1/custom-connectors"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8080/v1/custom-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_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/v1/custom-connectors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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 := "http://localhost:8080/v1/custom-connectors"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/v1/custom-connectors")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/v1/custom-connectors")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"connector_id": "c0ffee01-1234-5678-90ab-cdef01234567",
"name": "Acme CRM",
"source_name": "acme-crm",
"created_at": "<string>",
"created_by": {
"type": "user",
"id": "u_01abc123"
},
"is_active": true,
"table_name": "custom_acme_crm",
"accepted_kinds": [
"email",
"page"
],
"metadata": {
"env": "staging"
}
}
]{
"error_code": "authentication_error",
"message": "Invalid or missing credentials.",
"details": {}
}{
"error_code": "permission_denied",
"message": "You do not have permission to perform this action.",
"details": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error_code": "internal_server_error",
"message": "An unexpected error occurred.",
"details": {}
}Query Parameters
Response
Successful Response
Unique identifier for the connector.
"c0ffee01-1234-5678-90ab-cdef01234567"
Human display name.
"Acme CRM"
Immutable slug used in the event source (custom:<source_name>).
"acme-crm"
ISO 8601 creation timestamp.
Principal that created a resource. id is a user_id for type="user"
and a key_id (UUID) for type="api_key".
Show child attributes
Show child attributes
False once the connector has been deactivated.
Table in POST /v1/knowledge/query holding one row per record pushed through /ingest, one column per top-level field. It appears after the next knowledge build.
"custom_acme_crm"
Kinds this connector may emit: first-party kinds and/or evidence types. Empty = all allowed.
["email", "page"]
Key/value metadata applied to every event from this connector. String values only. Per-item metadata on ingest overrides on key conflict.
Show child attributes
Show child attributes
{ "env": "staging" }
Was this page helpful?