GET/data_connectors/{id}/versions/{version_id}

Retrieve a version of a data connector

Retrieves a single version snapshot of a data connector, including the connector configuration as it was at that version. Use the version's entity_version_id as version_id. Access requires a version-reading OAuth scope.

3 parameters
idstringrequired
The unique identifier of the data connector.
version_idintegerrequired
The version's `entity_version_id`, returned when listing data connector versions.
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

3 status codes
200Returns the version snapshot, including its current status, optional note, author, creation time, version identifier, and connector definition at that version.
typestringoptional
The type of object - `data_connector_version`.
Allowed:data_connector_version
statusstringoptional
The status of this version today.
Allowed:livepauseddraftpreviously_live
notestringoptional
A note describing this version, if one has been set.
authorobjectoptional
The teammate who created this version.
created_atstringoptional
The time this version was created.
entity_version_idintegeroptional
The identifier of this version. Use it as `version_id` when retrieving or updating a version.
definitionobjectoptional
The data connector's configuration at this version. `null` if the snapshot is no longer available. Mirrors the response of [Retrieve a data connector](/docs/references/rest-api/api.intercom.io/data-connectors/retrievedataconnector), without `id`, `type`, `created_by_admin_id`, `updated_by_admin_id`, `created_at`, `updated_at`, `execution_results_url` and `transform_code_block`.
401Returned when the request is unauthorized.

2 documented failures

  • unauthorized

    Access Token Invalid

  • token_unauthorized

    Not authorized to access resource

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

2 documented failures

  • data_connector_not_found

    Data connector not found

  • not_found

    Resource Not Found

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

Error handling

A 401 is returned when the request is unauthorized, and a 404 when the data connector or version is not found. Use the read_data_connector_versions or read_write_data_connector_versions OAuth scope; the id path parameter must identify a data connector and the version_id path parameter must be its version's entity_version_id.