API Reference

List connector type schemas

View Markdown

GET /api/connectors/types

Returns the available connector types, configuration schemas, and server upload limits.

Operation IDgetConnectorTypes

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Success response body

200Connector type schemas

Connector type schemas

Content typeapplication/json

responseobject

2 properties

typesarray<object>

Array items

itemobject

5 properties

typestring

labelstring

configSchemaobject

Additional properties are allowed.

capabilitiesobject

Additional properties are allowed.

integrated_account_explorerboolean

Connector supports integrated-account Data Explorer (Truto, Cardamom, etc.)

Additional properties are allowed.

upload_max_bytesinteger

Server-wide connector file upload limit in bytes.

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/connectors/types' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/connectors/types", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);