---
canonical_url: "https://docs.composio.dev/toolkits/retable"
markdown_url: "https://docs.composio.dev/toolkits/retable.md"
product: "platform"
version: null
last_updated: null
---

# Retable

Retable is a collaborative spreadsheet and database platform for organizing workspaces, projects, tables, columns, rows, and files.

- **Category:** spreadsheets
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 11
- **Triggers:** 0
- **Slug:** `RETABLE`
- **Version:** 00000000_00

## Tools

### Add Columns

**Slug:** `RETABLE_ADD_COLUMNS`

Append one or more typed columns to a table and return the complete resulting column list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `columns` | array | Yes | Columns to append in one batch. |
| `table_id` | string | Yes | Table ID that will receive the new columns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Columns

**Slug:** `RETABLE_DELETE_COLUMNS`

Permanently delete one or more columns and their cell data, then return the complete remaining column list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `table_id` | string | Yes | Table ID containing the columns to delete. |
| `column_ids` | array | Yes | Column IDs to permanently delete in one batch; deleting a column also removes its cell data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Rows

**Slug:** `RETABLE_DELETE_ROWS`

Permanently delete one or more rows from a table; missing row IDs are ignored and count as zero deletions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `row_ids` | array | Yes | Row IDs to permanently delete in one batch. |
| `table_id` | string | Yes | Table ID containing the rows to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rows

**Slug:** `RETABLE_GET_ROWS`

Return all rows or up to 50 selected rows using stable column IDs or title-keyed fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("column_ids" | "column_titles") | No | Row shape: column_ids returns stable column objects; column_titles returns a fields object keyed by mutable column titles. |
| `row_ids` | array | No | Optional non-empty list of row IDs to select, up to 50. Omit to return every row because this endpoint has no pagination. |
| `table_id` | string | Yes | Table ID whose rows to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Table

**Slug:** `RETABLE_GET_TABLE`

Get one table's metadata, column IDs and types, and views before reading or changing its data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `table_id` | string | Yes | Table ID returned by LIST_PROJECT_TABLES. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Insert Rows

**Slug:** `RETABLE_INSERT_ROWS`

Insert one or more rows into a table in one request and return the created rows with their IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rows` | array | Yes | Rows to insert in one batch. |
| `table_id` | string | Yes | Table ID that will receive the new rows. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Project Tables

**Slug:** `RETABLE_LIST_PROJECT_TABLES`

List tables in one Retable project with their IDs, columns, and parent workspace and project IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID returned by List Workspace Projects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspace Projects

**Slug:** `RETABLE_LIST_WORKSPACE_PROJECTS`

List projects accessible in one workspace, including project IDs needed to discover tables.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Workspace ID returned by LIST_WORKSPACES. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspaces

**Slug:** `RETABLE_LIST_WORKSPACES`

List workspaces visible to the connected Retable account, including each workspace ID needed to discover projects.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Rows

**Slug:** `RETABLE_SEARCH_ROWS`

Search a table for a value in a primary column and return matching rows from an optional starting offset. For text columns, Retable matches the full cell value rather than partial text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `term` | string | Yes | Value to match in the primary column. Text-column searches require the full cell value; partial text does not match. |
| `offset` | integer | No | Number of matching rows to skip before returning all remaining matches. |
| `table_id` | string | Yes | Table ID to search. |
| `column_id` | string | Yes | Primary column ID to search, available from GET_TABLE. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Rows

**Slug:** `RETABLE_UPDATE_ROWS`

Update cells in one or more existing rows in one request and return the updated row IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rows` | array | Yes | Existing rows and cell changes to apply in one batch. |
| `table_id` | string | Yes | Table ID containing the rows to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |