> This page is for Developer Documentation.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.benchling.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.benchling.com/_mcp/server.

# Get DataFrame by ID

GET https://{tenant_name}.benchling.com/api/v3/data-frame/{data_frame_id}

Get a single DataFrame by ID.

Reference: https://docs.benchling.com/docs/api/benchling-api/data-frame/get

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `data_frame_id` (string, required) — ID of the DataFrame.

### Query parameters

- `returning` (string, optional) — Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.
- `omit` (string, optional) — Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

### Headers

- `EARLY-ACCESS` (string, optional) — Set to true to access beta operations via /api/v3.

## Response

### 200

OK

- `__typename` (string, optional)
- `columns` (list of DataFrameColumn, optional)
- `createdAt` (string, optional)
- `creator` (PrincipalRef, optional)
- `dataset` (DatasetRef, optional, nullable)
- `errorMessage` (string, optional, nullable)
- `id` (string, optional)
- `manifest` (list of DataFrameManifestItem, optional)
- `modifiedAt` (string, optional)
- `name` (string, optional)
- `size` (integer, optional)
- `uploadStatus` (enum, optional)
  - Allowed values: `SUCCEEDED`, `FAILED_VALIDATION`, `IN_PROGRESS`, `NOT_UPLOADED`

## Errors

### 400 Data Frame Get Request Bad Request Error

Bad Request

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 403 Data Frame Get Request Forbidden Error

Forbidden

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 404 Data Frame Get Request Not Found Error

Not Found

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 429 Data Frame Get Request Too Many Requests Error

Too Many Requests

- `detail` (TooManyRequestsErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)
- `violated-policies` (list of enum, optional) — The budget policies that rejected the request, in canonical order: `user`, `integration`, then `tenant`.
  - Allowed values: `user`, `integration`, `tenant`

### 500 Data Frame Get Request Internal Server Error

Internal Server Error

- `detail` (InternalServerErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `errorId` (string, optional)

## Types

### DataFrameColumn

Defines a column within a DataFrame, including its internal system name, user-facing display name, and data type specification.

- `__typename` (string, optional)
- `displayName` (string, optional)
- `systemName` (string, optional)
- `type` (map from string to any, optional)

### PrincipalRef

- `__typename` (string, optional)
- `id` (string, optional)

### DatasetRef

- `__typename` (string, optional)
- `id` (string, optional)

### DataFrameManifestItem

Represents one part of a DataFrame's downloadable row data. Currently, the manifest always contains exactly one item. The array structure is forward-compatible with future multi-part download support for large data frames.

- `__typename` (string, optional)
- `fileName` (string, optional)
- `url` (string, optional)

### GeneralErrorDetail

### TooManyRequestsErrorBodyDetail

### InternalServerErrorBodyDetail

## Examples

**Response**

```json
{
  "__typename": "__typename",
  "columns": [
    {
      "__typename": "__typename",
      "displayName": "displayName",
      "systemName": "systemName",
      "type": {
        "key": "value"
      }
    }
  ],
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "dataset": {
    "__typename": "__typename",
    "id": "id"
  },
  "errorMessage": "errorMessage",
  "id": "id",
  "manifest": [
    {
      "__typename": "__typename",
      "fileName": "fileName",
      "url": "url"
    }
  ],
  "modifiedAt": "modifiedAt",
  "name": "name",
  "size": 1,
  "uploadStatus": "SUCCEEDED"
}
```

**SDK Code**

```python
import requests

url = "https://{tenant_name}.benchling.com/api/v3/data-frame/data_frame_id"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://{tenant_name}.benchling.com/api/v3/data-frame/data_frame_id';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```