Intercom API (unofficial showcase)
GET/data_connectors/{id}

Retrieve a data connector

Retrieves the full details of a data connector by its identifier. Use state_version to choose whether to retrieve its draft or live configuration; it defaults to the live version when omitted.

3 parameters
idstringrequired
The unique identifier of the data connector to retrieve.
state_versionstringoptional
The connector version to retrieve: `draft` or `live`. Defaults to `live` when omitted.
Allowed:draftliveDefault:live
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

4 status codes
200Returns the data connector details, including its configuration, data inputs, response fields, and object mappings.
typestringoptional
The type of object - `data_connector`.
Allowed:data_connector
idstringoptional
The unique identifier for the data connector.
namestringoptional
The name of the data connector.
descriptionstringoptional
A description of what this data connector does.
statestringoptional
The current state of the data connector.
Allowed:draftlive
urlstringoptional
The URL of the external API endpoint. Supports template variables like `{{order_id}}`.
bodystringoptional
The request body template. Supports template variables.
headersarray<object>optional
HTTP headers for the request. Header values are always redacted as `"****"` in responses.
http_methodstringoptional
The HTTP method used by the data connector.
Allowed:getpostputdeletepatch
direct_fin_usagebooleanoptional
Whether this connector is used directly by Fin.
audiencesarray<string>optional
The audience types this connector targets.
execution_typestringoptional
How the connector executes.
Allowed:server_sideclient_side
configuration_response_typestringoptional
The expected response format from the connector.
Allowed:test_response_typemock_response_type
data_transformation_typestringoptional
The type of data transformation applied to the response.
Allowed:full_accessredacted_accesscode_block_transformation
client_function_namestringoptional
The name of the client-side function, if applicable.
client_function_timeout_msintegeroptional
Timeout in milliseconds for the client function, if applicable.
data_inputsarray<object>optional
The input parameters accepted by this data connector.
response_fieldsarray<object>optional
The fields returned in the connector response.
object_mappingsarray<object>optional
Mappings from connector response objects to Intercom objects.
token_idsarray<string>optional
IDs of authentication tokens associated with this connector.
customer_authenticationbooleanoptional
Whether OTP authentication is enabled for this connector.
bypass_authenticationbooleanoptional
Whether authentication is bypassed for this connector.
validate_missing_attributesbooleanoptional
Whether to validate missing attributes before execution.
created_by_admin_idstringoptional
The ID of the admin who created this connector.
updated_by_admin_idstringoptional
The ID of the admin who last updated this connector.
created_atstringoptional
The time the data connector was created.
updated_atstringoptional
The time the data connector was last updated.
execution_results_urlstringoptional
The URL path to fetch execution results for this connector.
400Returned when `state_version` is invalid.

One documented failure

  • parameter_invalid

    Invalid state_version. Must be one of: live, draft

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the data connector is not found.

One documented failure

  • data_connector_not_found

    Data connector not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 400 is returned when state_version is invalid, a 401 when the request is unauthorized, and a 404 when the data connector is not found. state_version must be draft or live, and the id path parameter must identify a data connector.