> ## Documentation Index
> Fetch the complete documentation index at: https://botpress-pb-update-api.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# findTableRows

> 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.



## OpenAPI

````yaml /tables-openapi.json post /v1/tables/{table}/rows/find
openapi: 3.0.0
info:
  title: Botpress Tables API
  description: API for Botpress Tables
  version: 1.112.0
servers:
  - url: https://api.botpress.cloud
security:
  - BearerAuth: []
tags:
  - name: documented
paths:
  /v1/tables/{table}/rows/find:
    post:
      tags:
        - Endpoints
      description: >-
        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.
      operationId: findTableRows
      parameters:
        - name: table
          in: path
          description: >-
            The table's name or unique identifier for targeting specific table
            operations.
          required: true
          schema:
            type: string
        - name: x-bot-id
          in: header
          description: Bot id
          required: true
          schema:
            type: string
        - name: x-integration-id
          in: header
          description: Integration id
          required: false
          schema:
            type: string
        - name: x-integration-alias
          in: header
          description: Integration alias
          required: false
          schema:
            type: string
        - name: x-integration-name
          in: header
          description: Integration name
          required: false
          schema:
            type: string
        - name: x-user-id
          in: header
          description: User Id
          required: false
          schema:
            type: string
        - name: x-user-role
          in: header
          description: User Role
          required: false
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/findTableRowsBody'
      responses:
        '200':
          $ref: '#/components/responses/findTableRowsResponse'
        default:
          $ref: '#/components/responses/findTableRowsResponse'
components:
  requestBodies:
    findTableRowsBody:
      description: >-
        The search criteria and filters to apply when searching for rows. This
        includes conditions, search terms, and pagination options.
      content:
        application/json:
          schema:
            type: object
            properties:
              limit:
                default: 100
                type: integer
                minimum: 1
                maximum: 1000
                description: >-
                  Limit for pagination, specifying the maximum number of rows to
                  return.
              offset:
                default: 0
                type: integer
                minimum: 0
                description: >-
                  Offset for pagination, specifying where to start returning
                  rows from.
              filter:
                type: object
                additionalProperties: true
                description: >-
                  Provide a mongodb-like filter to apply to the query. Example:
                  \{ "name": \{ "$eq": "John" \} \}
              group:
                type: object
                additionalProperties: true
                description: >-
                  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:
                type: string
                maxLength: 1024
                description: >-
                  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. 
              select:
                type: array
                items:
                  type: string
                description: >-
                  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:
                default: id
                type: string
                description: >-
                  Specifies the column by which to order the results. By default
                  it is ordered by id. Build-in columns: id, createdAt,
                  updatedAt
              orderDirection:
                default: asc
                type: string
                enum:
                  - asc
                  - desc
                description: >-
                  Specifies the direction of sorting, either ascending or
                  descending.
            title: findTableRowsBody
            additionalProperties: false
  responses:
    findTableRowsResponse:
      description: >-
        A collection of rows that match the search criteria, along with metadata
        such as total count and pagination details.
      content:
        application/json:
          schema:
            type: object
            properties:
              rows:
                type: array
                items:
                  $ref: '#/components/schemas/Row'
              hasMore:
                type: boolean
                description: Flag indicating if there are more rows to fetch.
              offset:
                type: integer
              limit:
                type: integer
              warnings:
                type: array
                items:
                  type: string
                description: >-
                  Alerts for minor issues that don't block the operation but
                  suggest possible improvements.
            required:
              - rows
              - hasMore
              - offset
              - limit
            title: findTableRowsResponse
            additionalProperties: false
  schemas:
    Row:
      type: object
      properties:
        id:
          type: number
          description: Unique identifier for the row.
        createdAt:
          type: string
          format: date-time
          description: Timestamp of row creation.
        updatedAt:
          type: string
          format: date-time
          description: Timestamp of the last row update.
        computed:
          type: object
          additionalProperties:
            type: object
            properties:
              status:
                type: string
              error:
                type: string
              updatedBy:
                type: string
              updatedAt:
                type: string
            required:
              - status
            additionalProperties: false
        stale:
          type: array
          items:
            type: string
          description: '[Read-only] List of stale values that are waiting to be recomputed.'
        similarity:
          type: number
          description: >-
            Optional numeric value indicating similarity, when using
            findTableRows.
      required:
        - id
        - computed
      additionalProperties: true
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````