Find Table Rows

post https://api.botpress.cloud/v1/tables/{table}/rows/find

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 Params

table

string

required

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

Body Params

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

limit

integer

1 to 1000

Defaults to 100

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

offset

integer

≥ 0

Defaults to 0

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

filter

object

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

group

object

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"] }

string

length ≤ 1024

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.

orderBy

string

Defaults to id

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

orderDirection

string

Defaults to asc

Specifies the direction of sorting, either ascending or descending.

Headers

x-bot-id

string

required

Bot ID

x-workspace-id

string

required

Workspace ID

Responses

Language

Credentials

Bearer

PAT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.botpress.cloud/v1/tables/table/rows/find \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A collection of rows that match the search criteria, along with metadata such as total count and pagination details.

defaultA collection of rows that match the search criteria, along with metadata such as total count and pagination details.