List connector type schemas

GET /api/connectors/types

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

Operation ID: getConnectorTypes

Authentication

Option 1

• BearerAuth (http bearer) API key token. Create via POST /api/api-keys. Format: envoy_<hex>

Option 2

• CookieAuth (apiKey) Session cookie set after login + TOTP verification

Success responses

200

Connector type schemas

Content type: application/json

• Type: object
• Properties:
  • types (array<object>)
    • Items:
      • Type: object
      • Properties:
        • type (string)
        • label (string)
        • configSchema (object)
          • Additional properties: allowed
        • capabilities (object)
          • Additional properties: allowed
        • integrated_account_explorer (boolean) — Connector supports integrated-account Data Explorer (Truto, Cardamom, etc.)
      • Additional properties: allowed
  • upload_max_bytes (integer) — Server-wide connector file upload limit in bytes.

Examples

cURL

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

JavaScript (fetch)

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);