Skip to content
Home/
REST API Reference
/
/
Data Connector Version

Data Connector Version

A point-in-time snapshot of a data connector's configuration, with the version's status and an optional note.

typestring

The type of object - data_connector_version.

Value:"data_connector_version"
Example:"data_connector_version"
statusstring

The status of this version today.

Enum:"live""paused""draft""previously_live"
Example:"live"
notestring or null

A note describing this version, if one has been set.

Example:"Switched to the v2 orders endpoint"
authorobject or null

The teammate who created this version.

created_atstring, (date-time)

The time this version was created.

Example:"2026-09-14T10:02:11Z"
entity_version_idinteger

The identifier of this version. Use it as version_id when retrieving or updating a version.

Example:9821
definitionobject or null

The data connector's configuration at this version. null if the snapshot is no longer available. Mirrors the response of Retrieve a data connector, without id, type, created_by_admin_id, updated_by_admin_id, created_at, updated_at, execution_results_url and transform_code_block.

{
  "type": "data_connector_version",
  "status": "live",
  "note": "Switched to the v2 orders endpoint",
  "author": {
    "id": 456,
    "name": "Alice Admin"
  },
  "created_at": "2026-09-14T10:02:11Z",
  "entity_version_id": 9821,
  "definition": {
    "name": "Order Status Service",
    "description": "string",
    "internal_description": "string",
    "state": "live",
    "url": "string",
    "body": "string",
    "headers": [ … ],
    "http_method": "get",
    "direct_fin_usage": true,
    "audiences": [ … ],
    "execution_type": "string",
    "configuration_response_type": "string",
    "data_transformation_type": "string",
    "client_function_name": "string",
    "client_function_timeout_ms": 0,
    "data_inputs": [ … ],
    "response_fields": [ … ],
    "object_mappings": [ … ],
    "token_ids": [ … ],
    "customer_authentication": true,
    "bypass_authentication": true,
    "enforce_auth": true,
    "validate_missing_attributes": true
  }
}