Skip to content

List connector types and instances

GET
/api/v1/connectors

Returns all available connector types and the tenant’s connected instances.

Authorizations

Responses

200

Successful Response

Response for GET /connectors.

Attributes: available_types: All registered connector types. connected: Connector instances for this tenant.

object
available_types
required
Array<object>

Metadata for an available connector type.

Attributes: slug: URL-safe identifier (e.g. ‘stripe’). display_name: Human-readable name. description: What this connector provides. auth_type: Authentication mechanism.

object
auth_type
required
string
description
required
string
display_name
required
string
slug
required
string
connected
required
Array<object>

Metadata for a connected connector instance.

Attributes: connector_id: Unique instance identifier. service_slug: The connector type slug. display_name: Human-readable name. status: Current lifecycle status.

object
connector_id
required
string
display_name
required
string
service_slug
required
string
status
required
string