v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-014430130.6 KB

rows

Search for rows

post/tables/{tableId}/rows/search

Path parameters

tableIdstring required

The ID of the table which this request is targeting.

Headers

x-budibase-app-idstring required

The ID of the app which this request is targeting.

Request body

paginateboolean

Enables pagination, by default this is disabled.

limitinteger

The maximum number of rows to return, useful when paginating, for internal tables this will be limited to 1000, for SQL tables it will be 5000.

Example request

{
  "query": {
    "string": {
      "columnName1": "value",
      "columnName2": "value"
    },
    "range": {
      "columnName1": {
        "low": 10,
        "high": 20
      }
    },
    "empty": {
      "columnName1": ""
    },
    "contains": {
      "arrayColumn": [
        "a",
        "b"
      ]
    },
    "notContains": {
      "arrayColumn": [
        "a",
        "b"
      ]
    },
    "containsAny": {
      "arrayColumn": [
        "a",
        "b"
      ]
    }
  }
}

Response

The response will contain an array of rows that match the search parameters.

dataobject[] required

An array of rows, these will each contain an _id field which can be used to update or delete them.

hasNextPageboolean

If pagination in use, this will determine if there is another page to fetch.