getTable

Retrieves detailed information about a specific table, identified by its name or unique identifier.

GET/v1/tables/{table}

Authorization

AuthorizationBearer

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

Header parameters

x-bot-idstring

Bot id

x-integration-id?string

Integration id

x-integration-alias?string

Integration alias

x-integration-name?string

Integration name

x-user-id?string

User Id

x-user-role?string

User Role

Path parameters

tablestring

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

Response

Details of the requested table, including row count and indexing status.

tableobject

rowsnumber

The total number of rows present in the table.

stalenumber

The number of stale rows that are waiting to be processed

indexingnumber

The number of rows that are waiting to be indexed (for search)

Request

curl --request GET \ \
  --url https://api.botpress.cloud/v1/tables/{table} \
  --header 'x-bot-id: <x-bot-id>' \
  --header 'Authorization: Bearer <token>'

Response

{
  "table": {
    "id": "string",
    "name": "string",
    "factor": 1,
    "frozen": true,
    "keyColumn": "string",
    "schema": {
      "$schema": "string",
      "properties": {
        "key": {
          "type": "string",
          "format": "date-time",
          "description": "string",
          "pattern": "string",
          "enum": [],
          "items": {},
          "nullable": true,
          "properties": {
            "key": null
          },
          "x-zui": {}
        }
      },
      "additionalProperties": true,
      "required": [
        "string"
      ],
      "type": "object"
    },
    "tags": {
      "key": "string"
    },
    "isComputeEnabled": true,
    "createdAt": "2025-01-15T12:00:00Z",
    "updatedAt": "2025-01-15T12:00:00Z"
  },
  "rows": 0,
  "stale": 0,
  "indexing": 0
}