> 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 AppCanvas by ID

GET https://{tenant_name}.benchling.com/api/v3/app-canvas/{app_canvas_id}

Get a single AppCanvas by ID.

Reference: https://docs.benchling.com/docs/api/benchling-api/app-canvas/get

## Authentication

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

## Request

### Path parameters

- `app_canvas_id` (string, required) — ID of the AppCanvas.

### 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)
- `app` (IAppInstallationRef, optional)
- `archiveReason` (string, optional, nullable)
- `archived` (boolean, optional)
- `blocks` (list of AppCanvasBlocksItem, optional)
- `createdAt` (string, optional)
- `data` (string, optional, nullable)
- `enabled` (boolean, optional)
- `featureId` (string, optional, nullable)
- `id` (string, optional)
- `modifiedAt` (string, optional)
- `resourceId` (string, optional)
- `sessionId` (string, optional, nullable)

## Errors

### 400 App Canvas 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 App Canvas 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 App Canvas 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 App Canvas 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 App Canvas 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

### IAppInstallationRef

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

### AppCanvasBlocksItem

Union of ButtonUiBlock, ChipUiBlock, DropdownUiBlock, DropdownMultiValueUiBlock, FileUploadUiBlock, MarkdownUiBlock, SearchInputUiBlock, SearchInputMultiValueUiBlock, SectionUiBlock, SelectorInputUiBlock, SelectorInputMultiValueUiBlock, TextInputUiBlock, TableUiBlock

### GeneralErrorDetail

### TooManyRequestsErrorBodyDetail

### InternalServerErrorBodyDetail

### ButtonUiBlock

A button block that triggers an app interaction when clicked.

- `__typename` (string, optional)
- `enabled` (boolean, optional, nullable)
- `id` (string, optional)
- `text` (string, optional)

### ChipUiBlock

A chip block that displays a short piece of information.

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

### DropdownUiBlock

A dropdown block backed by a Benchling dropdown registry.

- `__typename` (string, optional)
- `dropdownId` (string, optional)
- `enabled` (boolean, optional, nullable)
- `id` (string, optional)
- `label` (string, optional, nullable)
- `placeholder` (string, optional, nullable)
- `required` (boolean, optional, nullable)
- `value` (string, optional, nullable)

### DropdownMultiValueUiBlock

A multi-select dropdown block backed by a Benchling dropdown registry.

- `__typename` (string, optional)
- `dropdownId` (string, optional)
- `enabled` (boolean, optional, nullable)
- `id` (string, optional)
- `label` (string, optional, nullable)
- `placeholder` (string, optional, nullable)
- `required` (boolean, optional, nullable)
- `value` (list of string, optional, nullable)

### FileUploadUiBlock

A file upload block that accepts one or more file attachments.

- `__typename` (string, optional)
- `enabled` (boolean, optional, nullable)
- `fileTypes` (list of string, optional, nullable)
- `id` (string, optional)
- `label` (string, optional, nullable)
- `maxFiles` (integer, optional, nullable)
- `required` (boolean, optional, nullable)
- `value` (list of string, optional, nullable)

### MarkdownUiBlock

A block that renders Markdown content.

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

### SearchInputUiBlock

A search input block for selecting a single Benchling entity.

- `__typename` (string, optional)
- `enabled` (boolean, optional, nullable)
- `id` (string, optional)
- `itemType` (enum, optional)
  - Allowed values: `DNA_SEQUENCE`, `DNA_OLIGO`, `AA_SEQUENCE`, `CUSTOM_ENTITY`, `MIXTURE`, `BOX`, `CONTAINER`, `LOCATION`, `PLATE`, `WORKLIST`
- `label` (string, optional, nullable)
- `placeholder` (string, optional, nullable)
- `required` (boolean, optional, nullable)
- `schemaId` (string, optional, nullable)
- `value` (string, optional, nullable)

### SearchInputMultiValueUiBlock

A multi-select search input block for selecting multiple Benchling entities.

- `__typename` (string, optional)
- `enabled` (boolean, optional, nullable)
- `id` (string, optional)
- `itemType` (enum, optional)
  - Allowed values: `DNA_SEQUENCE`, `DNA_OLIGO`, `AA_SEQUENCE`, `CUSTOM_ENTITY`, `MIXTURE`, `BOX`, `CONTAINER`, `LOCATION`, `PLATE`, `WORKLIST`
- `label` (string, optional, nullable)
- `placeholder` (string, optional, nullable)
- `required` (boolean, optional, nullable)
- `schemaId` (string, optional, nullable)
- `value` (list of string, optional, nullable)

### SectionUiBlock

A section block that groups child blocks together. Children are leaf blocks only.

- `__typename` (string, optional)
- `children` (list of SectionUiBlockChildrenItem, optional)
- `id` (string, optional)

### SelectorInputUiBlock

A selector input block with predefined options.

- `__typename` (string, optional)
- `enabled` (boolean, optional, nullable)
- `id` (string, optional)
- `label` (string, optional, nullable)
- `options` (list of string, optional)
- `placeholder` (string, optional, nullable)
- `required` (boolean, optional, nullable)
- `value` (string, optional, nullable)

### SelectorInputMultiValueUiBlock

A multi-select selector input block with predefined options.

- `__typename` (string, optional)
- `enabled` (boolean, optional, nullable)
- `id` (string, optional)
- `label` (string, optional, nullable)
- `options` (list of string, optional)
- `placeholder` (string, optional, nullable)
- `required` (boolean, optional, nullable)
- `value` (list of string, optional, nullable)

### TextInputUiBlock

A text input block that accepts freeform user text.

- `__typename` (string, optional)
- `enabled` (boolean, optional, nullable)
- `id` (string, optional)
- `label` (string, optional, nullable)
- `placeholder` (string, optional, nullable)
- `required` (boolean, optional, nullable)
- `value` (string, optional, nullable)

### TableUiBlock

A table block that displays tabular data from a dataset or data frame.

- `__typename` (string, optional)
- `dataFrameId` (string, optional)
- `enabled` (boolean, optional, nullable)
- `id` (string, optional)
- `name` (string, optional)

### SectionUiBlockChildrenItem

Union of ButtonUiBlock, ChipUiBlock, DropdownUiBlock, DropdownMultiValueUiBlock, FileUploadUiBlock, MarkdownUiBlock, SearchInputUiBlock, SearchInputMultiValueUiBlock, SelectorInputUiBlock, SelectorInputMultiValueUiBlock, TextInputUiBlock

## Examples

**Response**

```json
{
  "__typename": "__typename",
  "app": {
    "__typename": "__typename",
    "id": "id"
  },
  "archiveReason": "archiveReason",
  "archived": true,
  "blocks": [
    {
      "__typename": "__typename",
      "enabled": true,
      "id": "id",
      "text": "text"
    }
  ],
  "createdAt": "createdAt",
  "data": "data",
  "enabled": true,
  "featureId": "featureId",
  "id": "id",
  "modifiedAt": "modifiedAt",
  "resourceId": "resourceId",
  "sessionId": "sessionId"
}
```

**SDK Code**

```python
import requests

url = "https://{tenant_name}.benchling.com/api/v3/app-canvas/app_canvas_id"

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

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

print(response.json())
```

```javascript
const url = 'https://{tenant_name}.benchling.com/api/v3/app-canvas/app_canvas_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);
}
```