Find Table Rows

Enables the search and filtering of rows within a table based on specific criteria. This operation supports complex queries for advanced data manipulation and retrieval.

Path Parameters

table*string

The table's name or unique identifier for targeting specific table operations.

Request Body

application/json

The search criteria and filters to apply when searching for rows. This includes conditions, search terms, and pagination options.

TypeScript Definitions

Use the request body type in TypeScript.

limit?integer

Limit for pagination, specifying the maximum number of rows to return.

Range1 <= value <= 1000

Default100

offset?integer

Offset for pagination, specifying where to start returning rows from.

Range0 <= value

Default0

filter?

Provide a mongodb-like filter to apply to the query. Example: { "name": { "$eq": "John" } }

group?

Group the rows by a specific column and apply aggregations to them. Allowed values: key, avg, max, min, sum, count. Example: { "someId": "key", "orders": ["sum", "avg"] }

search?string

Search term to apply to the row search. When using this parameter, some rows which doesn't match the search term will be returned, use the similarity field to know how much the row matches the search term.

Lengthlength <= 1024

select?array<string>

Specify which columns to return in the response. Supports both top-level columns (e.g., "name") and nested attributes using dot notation (e.g., "attributes.price"). System columns (id, createdAt, updatedAt, etc.) are always included. If omitted, all columns are returned.

orderBy?string

Specifies the column by which to order the results. By default it is ordered by id. Build-in columns: id, createdAt, updatedAt

Default"id"

orderDirection?string

Specifies the direction of sorting, either ascending or descending.

Default"asc"

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X POST "https://example.com/v1/tables/string/rows/find" \  -H "Content-Type: application/json" \  -d '{}'

{  "rows": [    {      "id": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "computed": {        "property1": {          "status": "string",          "error": "string",          "updatedBy": "string",          "updatedAt": "string"        },        "property2": {          "status": "string",          "error": "string",          "updatedBy": "string",          "updatedAt": "string"        }      },      "stale": [        "string"      ],      "similarity": 0    }  ],  "hasMore": true,  "offset": 0,  "limit": 0,  "warnings": [    "string"  ]}

{  "rows": [    {      "id": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "computed": {        "property1": {          "status": "string",          "error": "string",          "updatedBy": "string",          "updatedAt": "string"        },        "property2": {          "status": "string",          "error": "string",          "updatedBy": "string",          "updatedAt": "string"        }      },      "stale": [        "string"      ],      "similarity": 0    }  ],  "hasMore": true,  "offset": 0,  "limit": 0,  "warnings": [    "string"  ]}

Path Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`