connectors

Get connector

Returns a single connector's details.

Stored credential fields such as passwords and provider keys are masked. System-generated connector secrets are returned so clients can configure and operate the connector.

Required permission: connectors.view.

get/v1/projects/{project_id}/connectors/{connector_id}

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/connectors/{connector_id}
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

connector_idstring uuid required

Connector ID from GET /connectors.

Response

Successful Response

idstring uuid required
project_idstring uuid required

Project the connector belongs to.

environment_idstring uuid required

Environment the connector runs in.

domain_idstring uuid nullable

Custom domain the connector's URL uses, or null for the default connector host.

namestring required
type'http' | 'cron' | 'kafka' | 'sqs' | 'postgres' | 'websocket' | 'mcp' | 'email' | 's3' | 'stripe' | 'telegram' | 'slack' | 'twilio' | 'twilio_messaging' | 'telnyx' | 'telnyx_messaging' required

Connector type, which sets the event source or destination and the fields accepted in config.

configobject required

Configuration for the connector type, with the fields documented on that connector's docs page. Credential fields are masked as ********; secrets connic generates for the connector, such as webhook secrets, are returned in full.

enabledboolean required

False while the connector is paused. A paused connector starts no new runs.

created_atstring date-time required
updated_atstring date-time required
managed_keystring nullable

Key of the connectors/<key>.yaml file that defines this connector in code, or null. Change these connectors in your codebase; the API can only pause or resume them.

retired_atstring date-time nullable

When the active deployment stopped declaring this connector in code, or null. Retired connectors stay paused until a deployment declares them again, and can be deleted.

Changes

No recorded changes to this operation across all 2 revisions of this API.