# Budibase

> Keep the data behind your Budibase internal tools up to date: add rows from forms, sales and emails, update them or add-or-update one matched by a column such as email, find and read them, and run saved queries. Start a workflow when a row is added or changed.

App · 10 actions. Web page: https://docs.lodol.com/docs/integrations/budibase

## Actions

### Create or update row

Update the row whose value in the column you match on is the one given, such as a contact with this email address, or add it if there is none, so a workflow that runs twice never adds it twice.

**Inputs**

- Workspace (`workspace_id`, text, required): The Budibase workspace (app) the table is in. Pick its name for the live data your apps' users see, or its development data for what Budibase shows in Dev. You can also paste its ID, which starts with app_.
- Table (`table_id`, text, required): The table to work with, such as Requests. Pick it from the list, or paste its ID (it starts with ta_).
- Match on (`match_field`, text, required): The column that tells rows apart, such as Email. Give its value in Fields; it must match exactly, upper and lower case included.
- Fields (`fields`, object, required): A value for each column to fill in, including the one to match on. An existing row keeps the columns left blank. For a linked row, give its name or ID; for a user, their email address; for several options or links, separate them with commas.

**Outputs**

- `created` (true/false): True if the row was added, false if an existing one was updated
- `created_at` (text): When the row was added (ISO 8601); empty for an external table
- `id` (text): The row's ID, such as ro_ta_...
- `row` (object): The row's columns and values, by column name, such as {"Title": "New laptop", "Status": "New"}. A linked row is a list of {"id", "name"}.
- `table_id` (text): The table the row is in
- `updated_at` (text): When the row was last changed (ISO 8601); empty for an external table
- `workspace_id` (text): The workspace the row is in (its published or development ID)

**Example output**

```json
{
  "created": true,
  "created_at": "2026-11-06T19:28:45.592Z",
  "id": "ro_ta_6d7cf023504c492db0ce5604eab87a67_c40be55a2e724823ad41cbba22dd07f3",
  "row": {
    "Approved": false,
    "Due date": "2026-12-01T00:00:00.000Z",
    "Quantity": 2,
    "Status": "New",
    "Team": [
      {
        "id": "ro_ta_0b1f_6a1703e154cf40bd",
        "name": "IT"
      }
    ],
    "Title": "New laptop"
  },
  "table_id": "ta_6d7cf023504c492db0ce5604eab87a67",
  "updated_at": "2026-11-06T19:28:45.592Z",
  "workspace_id": "app_0123456789abcdef0123456789abcdef"
}
```

### Create row

Add a row to a table, such as a request from a form, an order or an asset, with a value for each column you fill in.

**Inputs**

- Workspace (`workspace_id`, text, required): The Budibase workspace (app) the table is in. Pick its name for the live data your apps' users see, or its development data for what Budibase shows in Dev. You can also paste its ID, which starts with app_.
- Table (`table_id`, text, required): The table to work with, such as Requests. Pick it from the list, or paste its ID (it starts with ta_).
- Fields (`fields`, object, required): A value for each column to fill in. Columns left blank stay empty. For a linked row, give its name or ID; for a user, their email address; for several options or links, separate them with commas.

**Outputs**

- `created_at` (text): When the row was added (ISO 8601); empty for an external table
- `id` (text): The row's ID, such as ro_ta_...
- `row` (object): The row's columns and values, by column name, such as {"Title": "New laptop", "Status": "New"}. A linked row is a list of {"id", "name"}.
- `table_id` (text): The table the row is in
- `updated_at` (text): When the row was last changed (ISO 8601); empty for an external table
- `workspace_id` (text): The workspace the row is in (its published or development ID)

**Example output**

```json
{
  "created_at": "2026-11-06T19:28:45.592Z",
  "id": "ro_ta_6d7cf023504c492db0ce5604eab87a67_c40be55a2e724823ad41cbba22dd07f3",
  "row": {
    "Approved": false,
    "Due date": "2026-12-01T00:00:00.000Z",
    "Quantity": 2,
    "Status": "New",
    "Team": [
      {
        "id": "ro_ta_0b1f_6a1703e154cf40bd",
        "name": "IT"
      }
    ],
    "Title": "New laptop"
  },
  "table_id": "ta_6d7cf023504c492db0ce5604eab87a67",
  "updated_at": "2026-11-06T19:28:45.592Z",
  "workspace_id": "app_0123456789abcdef0123456789abcdef"
}
```

### Delete row

Delete one row of a table, for good.

**Inputs**

- Workspace (`workspace_id`, text, required): The Budibase workspace (app) the table is in. Pick its name for the live data your apps' users see, or its development data for what Budibase shows in Dev. You can also paste its ID, which starts with app_.
- Table (`table_id`, text, required): The table to work with, such as Requests. Pick it from the list, or paste its ID (it starts with ta_).
- Row ID (`row_id`, text, required): The row's ID (it starts with ro_), from the trigger or another Budibase step.

**Outputs**

- `deleted` (true/false): True once the row is deleted
- `id` (text): The deleted row's ID
- `table_id` (text): The table the row was in
- `workspace_id` (text): The workspace the row was in

**Example output**

```json
{
  "deleted": true,
  "id": "ro_ta_6d7cf023504c492db0ce5604eab87a67_c40be55a2e724823ad41cbba22dd07f3",
  "table_id": "ta_6d7cf023504c492db0ce5604eab87a67",
  "workspace_id": "app_0123456789abcdef0123456789abcdef"
}
```

### Find rows

Find the rows of a table whose column matches a value, such as every request waiting for approval, sorted the way you choose. Leave the filter blank to list them all, a page at a time.

**Inputs**

- Workspace (`workspace_id`, text, required): The Budibase workspace (app) the table is in. Pick its name for the live data your apps' users see, or its development data for what Budibase shows in Dev. You can also paste its ID, which starts with app_.
- Table (`table_id`, text, required): The table to work with, such as Requests. Pick it from the list, or paste its ID (it starts with ta_).
- Filter by column (`filter_field`, text): Only rows whose value in this column passes the filter. A linked row is compared by its name.
- Filter (`filter_operator`, text): How the column's value is compared. Equals matches exactly, upper and lower case included; Contains and Starts with ignore case. One of: `equals`, `not_equals` (Does not equal), `contains`, `starts_with` (Starts with), `at_least` (Greater than or equal to), `at_most` (Less than or equal to), `one_of` (Is one of), `empty` (Is empty), `not_empty` (Is not empty). Default: `equals`.
- Filter value (`filter_value`, text): The value to compare with: a date as 2026-11-05, a boolean as yes or no. For Is one of, separate the values with commas. Only when Filter is Equals, Does not equal, Contains, Starts with, Greater than or equal to, Less than or equal to or Is one of.
- Sort by (`sort_field`, text): The column to sort the rows by. Leave blank for Budibase's own order.
- Newest or highest first (`descending`, true/false): Sort from highest to lowest (newest first, Z to A). Default: `false`.
- How many (`limit`, number): The most rows to return, up to 1000. Defaults to 100. From 1 to 1000.
- Page (`page`, number): Which page of results to return, starting at 1. At least 1.

**Outputs**

- `count` (number): How many rows are listed
- `has_more` (true/false): True if there are more rows on the next page
- `ids` (list): The IDs of the rows listed
- `page` (number): Which page of results this is, starting at 1
- `rows` (list): The rows that match, each with its columns by name
- `table_id` (text): The table searched
- `workspace_id` (text): The workspace searched

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "ids": [
    "ro_ta_6d7cf023504c492db0ce5604eab87a67_c40be55a2e724823ad41cbba22dd07f3"
  ],
  "page": 1,
  "rows": [
    {
      "Approved": false,
      "Due date": "2026-12-01T00:00:00.000Z",
      "Quantity": 2,
      "Status": "New",
      "Team": [
        {
          "id": "ro_ta_0b1f_6a1703e154cf40bd",
          "name": "IT"
        }
      ],
      "Title": "New laptop"
    }
  ],
  "table_id": "ta_6d7cf023504c492db0ce5604eab87a67",
  "workspace_id": "app_0123456789abcdef0123456789abcdef"
}
```

### Get row

Read one row of a table by its ID, with its values.

**Inputs**

- Workspace (`workspace_id`, text, required): The Budibase workspace (app) the table is in. Pick its name for the live data your apps' users see, or its development data for what Budibase shows in Dev. You can also paste its ID, which starts with app_.
- Table (`table_id`, text, required): The table to work with, such as Requests. Pick it from the list, or paste its ID (it starts with ta_).
- Row ID (`row_id`, text, required): The row's ID (it starts with ro_), from the trigger or another Budibase step.

**Outputs**

- `created_at` (text): When the row was added (ISO 8601); empty for an external table
- `id` (text): The row's ID, such as ro_ta_...
- `row` (object): The row's columns and values, by column name, such as {"Title": "New laptop", "Status": "New"}. A linked row is a list of {"id", "name"}.
- `table_id` (text): The table the row is in
- `updated_at` (text): When the row was last changed (ISO 8601); empty for an external table
- `workspace_id` (text): The workspace the row is in (its published or development ID)

**Example output**

```json
{
  "created_at": "2026-11-06T19:28:45.592Z",
  "id": "ro_ta_6d7cf023504c492db0ce5604eab87a67_c40be55a2e724823ad41cbba22dd07f3",
  "row": {
    "Approved": false,
    "Due date": "2026-12-01T00:00:00.000Z",
    "Quantity": 2,
    "Status": "New",
    "Team": [
      {
        "id": "ro_ta_0b1f_6a1703e154cf40bd",
        "name": "IT"
      }
    ],
    "Title": "New laptop"
  },
  "table_id": "ta_6d7cf023504c492db0ce5604eab87a67",
  "updated_at": "2026-11-06T19:28:45.592Z",
  "workspace_id": "app_0123456789abcdef0123456789abcdef"
}
```

### List queries

List a workspace's saved queries, with the parameters each takes.

**Inputs**

- Workspace (`workspace_id`, text, required): The Budibase workspace (app) the table is in. Pick its name for the live data your apps' users see, or its development data for what Budibase shows in Dev. You can also paste its ID, which starts with app_.

**Outputs**

- `count` (number): How many queries are listed
- `queries` (list): The workspace's saved queries
- `workspace_id` (text): The workspace

**Example output**

```json
{
  "count": 1,
  "queries": [
    {
      "connection_id": "datasource_b371c62e1105436eb4ef64200ce18eda",
      "id": "query_datasource_b371c62e_0a594790d654",
      "kind": "read",
      "name": "Search orders",
      "parameters": [
        {
          "default": "",
          "name": "email"
        }
      ]
    }
  ],
  "workspace_id": "app_0123456789abcdef0123456789abcdef"
}
```

### List tables

List a workspace's tables, with each one's columns, their types and options, and the ones a new row must have.

**Inputs**

- Workspace (`workspace_id`, text, required): The Budibase workspace (app) the table is in. Pick its name for the live data your apps' users see, or its development data for what Budibase shows in Dev. You can also paste its ID, which starts with app_.

**Outputs**

- `count` (number): How many tables are listed
- `tables` (list): The workspace's tables
- `workspace_id` (text): The workspace

**Example output**

```json
{
  "count": 1,
  "tables": [
    {
      "created_field": "Created at",
      "display_column": "Title",
      "fields": [
        {
          "name": "Title",
          "options": [],
          "required": true,
          "type": "string",
          "writable": true
        },
        {
          "name": "Status",
          "options": [
            "New",
            "Approved",
            "Rejected"
          ],
          "required": false,
          "type": "options",
          "writable": true
        }
      ],
      "id": "ta_6d7cf023504c492db0ce5604eab87a67",
      "name": "Requests",
      "required_fields": [
        "Title"
      ],
      "updated_field": "Updated at"
    }
  ],
  "workspace_id": "app_0123456789abcdef0123456789abcdef"
}
```

### List workspaces

List the workspaces (apps) the API key's user can reach, each with the ID of its live data and of its development data.

**Inputs**: None.

**Outputs**

- `count` (number): How many are listed
- `workspaces` (list): Each workspace, once for its published data and once for its development data

**Example output**

```json
{
  "count": 1,
  "workspaces": [
    {
      "data": "published",
      "id": "app_0123456789abcdef0123456789abcdef",
      "name": "IT requests",
      "published": true,
      "published_id": "app_0123456789abcdef0123456789abcdef",
      "updated_at": "2026-11-06T19:31:25.696Z",
      "url": "/it-requests"
    }
  ]
}
```

### Run query

Run a query saved in a Budibase workspace, such as a REST call or a SQL statement on a connected database, with the parameters it takes, and get back what it returns.

**Inputs**

- Workspace (`workspace_id`, text, required): The Budibase workspace (app) the table is in. Pick its name for the live data your apps' users see, or its development data for what Budibase shows in Dev. You can also paste its ID, which starts with app_.
- Query (`query_id`, text, required): The saved query to run. Pick it from the list, or type its name.
- Parameters (`parameters`, object): A value for each of the query's parameters. Parameters left blank use the default set in Budibase.

**Outputs**

- `count` (number): How many rows it gave
- `name` (text): The query's name
- `query_id` (text): The query that ran
- `rows` (list): What the query gave, one entry per row or record
- `workspace_id` (text): The workspace

**Example output**

```json
{
  "count": 1,
  "name": "Search orders",
  "query_id": "query_datasource_b371c62e_0a594790d654",
  "rows": [
    {
      "email": "sam@example.com",
      "id": 1042,
      "total": 120.5
    }
  ],
  "workspace_id": "app_0123456789abcdef0123456789abcdef"
}
```

### Update row

Change some columns of a row, such as a request's status when it's approved. Columns left blank keep their value.

**Inputs**

- Workspace (`workspace_id`, text, required): The Budibase workspace (app) the table is in. Pick its name for the live data your apps' users see, or its development data for what Budibase shows in Dev. You can also paste its ID, which starts with app_.
- Table (`table_id`, text, required): The table to work with, such as Requests. Pick it from the list, or paste its ID (it starts with ta_).
- Row ID (`row_id`, text, required): The row's ID (it starts with ro_), from the trigger or another Budibase step.
- Fields (`fields`, object, required): The new value for each column to change. Columns left blank keep their value. For a linked row, give its name or ID; for a user, their email address; for several options or links, separate them with commas.

**Outputs**

- `created_at` (text): When the row was added (ISO 8601); empty for an external table
- `id` (text): The row's ID, such as ro_ta_...
- `row` (object): The row's columns and values, by column name, such as {"Title": "New laptop", "Status": "New"}. A linked row is a list of {"id", "name"}.
- `table_id` (text): The table the row is in
- `updated_at` (text): When the row was last changed (ISO 8601); empty for an external table
- `workspace_id` (text): The workspace the row is in (its published or development ID)

**Example output**

```json
{
  "created_at": "2026-11-06T19:28:45.592Z",
  "id": "ro_ta_6d7cf023504c492db0ce5604eab87a67_c40be55a2e724823ad41cbba22dd07f3",
  "row": {
    "Approved": false,
    "Due date": "2026-12-01T00:00:00.000Z",
    "Quantity": 2,
    "Status": "New",
    "Team": [
      {
        "id": "ro_ta_0b1f_6a1703e154cf40bd",
        "name": "IT"
      }
    ],
    "Title": "New laptop"
  },
  "table_id": "ta_6d7cf023504c492db0ce5604eab87a67",
  "updated_at": "2026-11-06T19:28:45.592Z",
  "workspace_id": "app_0123456789abcdef0123456789abcdef"
}
```
