POST
/
v1
/
tables
/
{table}
/
rows
/
find
cURL
curl --request POST \
  --url https://api.botpress.cloud/v1/tables/{table}/rows/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <api-key>' \
  --data '{
  "limit": 100,
  "offset": 0,
  "filter": {},
  "group": {},
  "search": "<string>",
  "orderBy": "id",
  "orderDirection": "asc"
}'
{
  "rows": [
    {
      "id": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "computed": {},
      "stale": [
        "<string>"
      ],
      "similarity": 123
    }
  ],
  "hasMore": true,
  "offset": 123,
  "limit": 123,
  "warnings": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
x-bot-id
string
header
required

Your bot ID.

Path Parameters

​
table
string
required

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

Body

application/json

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

The body is of type object.

Response

200
application/json

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

The response is of type object.