---
title: "Get AutomationTemplateVariable by ID"
method: GET
path: "/api/v3/automation-template-variable/{automation_template_variable_id}"
tags: ["Automation Template Variable"]
---

# Get AutomationTemplateVariable by ID

`GET /api/v3/automation-template-variable/{automation_template_variable_id}`

## Request

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

Get a single AutomationTemplateVariable by ID.

## Path parameters

- `automation_template_variable_id` string, required

## Query parameters

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

## Headers

- `EARLY-ACCESS` string

## Response `200`

OK

- AutomationTemplateVariable: Defines a configuration parameter within an AutomationTemplate that users can customize when applying the template. Unlike AutomationTemplateDataFrameVariable which handles data frame inputs, this type represents scalar configuration values such as thresholds, filter criteria, or algorithm parameters. The configVariableKey identifies which step configuration field this variable controls, and variableTypeConfigSpec defines the allowed value types. When users apply a template, they provide values for these variables that configure the behavior of the corresponding AutomationStep. Note: These are surfaced as "config variables" on the AutomationTemplate object.
  - `__typename` string
  - `archiveReason` string, nullable
  - `archived` boolean
  - `automationStep` AutomationStepRef
    - `__typename` string
    - `id` string, api_id
  - `configVariableKey` string
  - `createdAt` string, datetime
  - `id` string
  - `modifiedAt` string, datetime
  - `name` string
  - `pipelineStep` AutomationStepRef
    - `__typename` string
    - `id` string, api_id
  - `template` AutomationTemplateRef
    - `__typename` string
    - `id` string, api_id
  - `variableTypeConfigSpec` AutomationTemplateVariableVariableTypeConfigSpec: Defines the allowed value type and validation constraints for this variable. The structure depends on the variable's data type.

## 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)
