Reference · Tools

Stackby

Read, write, and delete data in Stackby spreadsheet database tables

Action Data & Storage v1

The Stackby node reads, writes, lists and deletes rows in Stackby tables through the REST API. A typical build is appending each processed record into a Stackby table that the rest of the team already works in, without anyone copying data by hand.

Node type
Action
Parameters
9
Outputs
Output, Error
Credentials
Stackby API

Stackby

Read, write, and delete data in Stackby tables

Overview

Stackby is a spreadsheet-database platform that combines the simplicity of spreadsheets with the power of databases. This tool interacts with the Stackby REST API to append (create), read, list, and delete rows in Stackby tables within stacks. It supports offset-based pagination for listing rows, optional view filtering, and batching of append operations by stack/table combination.

Category: Data & Storage
Tool Name: stackby
Version: 1

Appearance: Icon: lucide-Table | Color: #5A67D8

Node Type

Action — processes input items and produces output

Input / Output

DirectionPort(s)
InputInput
OutputOutput, Error

Credentials

This tool requires Stackby API credentials. See the Credentials Guide for setup instructions.

Operations

OperationValueDescription
AppendappendCreate a new row in a table
DeletedeleteDelete a row from a table
ListlistList rows from a table
ReadreadRead a single row by ID

Parameters

Append (append)

ParameterTypeRequiredDefaultDescription
ColumnsstringYesComma-separated list of the properties which should be used as columns for the new rows. The input item must have JSON properties matching each column name. Supports expressions like {{ $json.columnList }}.

Delete (delete)

ParameterTypeRequiredDefaultDescription
IDstringYesID of the row to read or delete. Supports expressions like {{ $json.rowId }}.

List (list)

ParameterTypeRequiredDefaultDescription
Return AllbooleanNotrueWhether to return all results or only up to a given limit.
LimitnumberNo1000Max number of results to return. (shown when Return All is false)
Additional FieldscollectionNo{}Additional options for the list operation.
— ViewstringNoThe name or ID of a view in the table. If set, only the records in that view will be returned, sorted according to the view order.

Read (read)

ParameterTypeRequiredDefaultDescription
IDstringYesID of the row to read or delete. Supports expressions like {{ $json.rowId }}.

All Operations

ParameterTypeRequiredDefaultDescription
Stack IDstringYesThe ID of the Stackby stack to access. Find this in your Stackby stack URL. Supports expressions like {{ $json.stackId }}.
TablestringYesThe name of the table to operate on. Supports expressions like {{ $json.table }}.
Max ConcurrencynumberNo10Maximum number of items to process concurrently.

Output Data

The row is the output item: each output item’s JSON is the row’s own columns, so a column called email is addressable downstream as {{ $json.email }}. The input item’s other JSON fields do not pass through — put an Edit Fields or Merge node after this one if you need to carry them along. Binary data on the input item is forwarded.

OperationWhat lands on the output itemItems produced per input item
appendThe created row’s columns — the ones you named in ColumnsOne
readThe row’s columnsOne per row returned by the lookup; an ID that matches nothing yields a single item with empty JSON
listEach row’s columnsOne per row returned — listing a 200-row table turns one input item into 200 output items. An empty table or view yields a single item with empty JSON
deleteThe deletion confirmation Stackby returns for that rowOne

A few behaviors worth planning around:

  • Append batches by destination. All input items that resolve to the same Stack ID and Table are written in one call, and each input item still gets its own output item back. Items that resolve to a different stack or table form their own batch.
  • Append reads the columns off the item. Every name in Columns must exist as a JSON property on the input item; a missing property fails that item rather than writing a blank cell.
  • Return All pages through the whole table. With Return All off, Limit caps how many rows come back (up to 1000).

Usage Examples

  • Create a new row in a Stackby table
  • List all rows from a Stackby table
  • Read a specific row by ID from Stackby
  • Delete a row by ID from a Stackby table

Example Configuration

Append one row per input item, built from three of the item’s properties:

{
  "type": "stackby",
  "parameters": {
    "operation": "append",
    "stackId": "st-abc123def456",
    "table": "Contacts",
    "columns": "name,email,phone",
    "maxConcurrency": 5
  }
}

List every row in a table:

{
  "type": "stackby",
  "parameters": {
    "operation": "list",
    "stackId": "st-abc123def456",
    "table": "Contacts",
    "returnAll": true
  }
}

List up to 50 rows from a single view:

{
  "type": "stackby",
  "parameters": {
    "operation": "list",
    "stackId": "st-abc123def456",
    "table": "Contacts",
    "returnAll": false,
    "limit": 50,
    "additionalFields": {
      "view": "Active Contacts"
    }
  }
}

Read the row whose ID arrives on the item:

{
  "type": "stackby",
  "parameters": {
    "operation": "read",
    "stackId": "st-abc123def456",
    "table": "ProcessingQueue",
    "id": "{{ $json.recordId }}"
  }
}

Delete the row whose ID arrives on the item:

{
  "type": "stackby",
  "parameters": {
    "operation": "delete",
    "stackId": "st-abc123def456",
    "table": "TempData",
    "id": "{{ $json.obsoleteRecordId }}",
    "maxConcurrency": 5
  }
}

Error Handling

ModeBehavior
stopHalts workflow on first error
continueSkips failed items, passes successful ones through
errorPortRoutes failed items to Error output port

Tips

Read, write, list, and delete rows in Stackby spreadsheet database tables using the Stackby REST API.

Frequently asked questions

Which operations are supported?

Read, write, list and delete on rows — the core CRUD set for working with table data.

What does it need to identify a table?

The stack and table identifiers from Stackby, which address the specific table the operation applies to.

Is it a good fit for syncing data?

Yes — appending or updating rows from another system is the common pattern, keeping a Stackby table current automatically.

Which credential does it need?

A Stackby API credential.

Build with the Stackby node

Drop it into a workflow, wire it to an agent, or call it on a schedule. You'll need Stackby API credentials first.

Open BusyBot

Last updated . Spotted something wrong? Tell us.