---
title: "Get AutomationTemplateDataFrameVariable by ID"
method: GET
path: "/api/v3/automation-template-data-frame-variable/{automation_template_data_frame_variable_id}"
tags: ["Automation Template Data Frame Variable"]
---

# Get AutomationTemplateDataFrameVariable by ID

`GET /api/v3/automation-template-data-frame-variable/{automation_template_data_frame_variable_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/automation-template-data-frame-variable/{automation_template_data_frame_variable_id}`
- Auth: HTTP bearer

Get a single AutomationTemplateDataFrameVariable by ID.

## Path parameters

- `automation_template_data_frame_variable_id` string, required

## Query parameters

- `returning` string[]
- `omit` string[]

## Headers

- `EARLY-ACCESS` string

## Response `200`

OK

- AutomationTemplateDataFrameVariable: Defines a data frame placeholder within an AutomationTemplate that users must provide when applying the template. Each variable specifies which AutomationStep input (replaceStep, replaceStepData, replaceStepDataIndex) will receive the user-provided data frame. The replaceDataFrameColumnsSpec field defines the expected column structure that the provided data must match. When users apply an automation template to create an Analysis, they provide bindings that map actual data frames to these variables, populating the template's pipeline with real data.
  - `__typename` string
  - `archiveReason` string, nullable
  - `archived` boolean
  - `createdAt` string, datetime
  - `description` string
  - `id` string
  - `modifiedAt` string, datetime
  - `name` string
  - `replaceDataFrameColumnsSpec` DataFrameColumn[]: Expected column structure that the provided DataFrame must match.
    - `__typename` string
    - `displayName` string
    - `systemName` string
    - `type` DataFrameColumnType
  - `replaceStep` AutomationStepRef
    - `__typename` string
    - `id` string, api_id
  - `replaceStepData` AutomationStepDataRef
    - `__typename` string
    - `id` string, api_id
  - `replaceStepDataIndex` integer: The index within the step data slot where the bound DataFrame is placed.
  - `template` AutomationTemplateRef
    - `__typename` string
    - `id` string, api_id

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/c9f087b98b8b?raw)