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

# ApptiveGrid

ApptiveGrid is a collaborative no-code database and app platform for managing spaces, grids, forms, and structured records.

- **Category:** databases
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 7
- **Triggers:** 0
- **Slug:** `APPTIVEGRID`
- **Version:** 00000000_00

## Tools

### Create Record

**Slug:** `APPTIVEGRID_CREATE_RECORD`

Create one record in a grid from a provider-native object keyed by that grid's field IDs or field keys; inspect the grid first to construct valid values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record` | object | Yes | Provider-native record keyed by field IDs or field keys for this grid. Use APPTIVEGRID_GET_GRID to obtain valid fields and match each value to its dynamic field type; this object is sent as the complete JSON body. |
| `grid_id` | string | Yes | Grid ID in which to create the record. |
| `user_id` | string | Yes | ApptiveGrid user ID returned by APPTIVEGRID_GET_CURRENT_USER. |
| `space_id` | string | Yes | Space ID containing the grid. |

#### 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 Current User

**Slug:** `APPTIVEGRID_GET_CURRENT_USER`

Return the connected ApptiveGrid user's ID, plan, seat availability, and resource links; use it to identify the user before listing spaces.

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

**Slug:** `APPTIVEGRID_GET_GRID`

Return a grid's metadata and dynamic field definitions; use it before listing, reading, or creating records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `grid_id` | string | Yes | Grid ID discovered from APPTIVEGRID_GET_SPACE. |
| `user_id` | string | Yes | ApptiveGrid user ID returned by APPTIVEGRID_GET_CURRENT_USER. |
| `space_id` | string | Yes | Space ID containing the grid. |

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

**Slug:** `APPTIVEGRID_GET_RECORD`

Return one record from a grid by record ID, optionally rendered with a provider layout.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `layout` | string ("field" | "property" | "key" | "keyAndField") | No | Object representation: field keys values by field ID; property keys values by field name; key uses field keys; keyAndField uses a field key when present and otherwise its ID. |
| `grid_id` | string | Yes | Grid ID containing the record. |
| `user_id` | string | Yes | ApptiveGrid user ID returned by APPTIVEGRID_GET_CURRENT_USER. |
| `space_id` | string | Yes | Space ID containing the grid. |
| `record_id` | string | Yes | Record ID returned in the _id field by APPTIVEGRID_LIST_RECORDS. |

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

**Slug:** `APPTIVEGRID_GET_SPACE`

Return a space and its grid summaries or grid links; use it to discover grid IDs before reading records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | ApptiveGrid user ID returned by APPTIVEGRID_GET_CURRENT_USER. |
| `space_id` | string | Yes | Space ID returned by APPTIVEGRID_LIST_SPACES. |

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

**Slug:** `APPTIVEGRID_LIST_RECORDS`

Return one 1-based page of records from a grid, optionally using the provider's layout, filter, and sorting definitions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | object | No | Provider-native filter object for this grid's dynamic fields. Obtain valid field IDs, keys, and types from APPTIVEGRID_GET_GRID. |
| `layout` | string ("field" | "property" | "key" | "keyAndField") | No | Object representation: field keys values by field ID; property keys values by field name; key uses field keys; keyAndField uses a field key when present and otherwise its ID. |
| `grid_id` | string | Yes | Grid ID whose records to list. |
| `sorting` | array | No | Provider-native sorting array for this grid's dynamic fields. It is JSON-encoded into the query. |
| `user_id` | string | Yes | ApptiveGrid user ID returned by APPTIVEGRID_GET_CURRENT_USER. |
| `space_id` | string | Yes | Space ID containing the grid. |
| `page_size` | integer | No | Maximum records to request on this page; no upper bound is documented. |
| `page_index` | integer | No | 1-based page number 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 |

### List Spaces

**Slug:** `APPTIVEGRID_LIST_SPACES`

Return one 1-based page of spaces available to a user, including IDs needed to inspect a space.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | ApptiveGrid user ID returned by APPTIVEGRID_GET_CURRENT_USER. |
| `page_size` | integer | No | Maximum spaces to request on this page; the provider documents no upper bound. |
| `page_index` | integer | No | 1-based page number 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 |