getTable

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

GET /v1/tables/{table}

cURL

cURL

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

200

{
  "table": {
    "id": "<string>",
    "name": "<string>",
    "schema": {
      "properties": {},
      "$schema": "<string>",
      "required": [
        "<string>"
      ]
    },
    "factor": 1,
    "frozen": true,
    "keyColumn": "<string>",
    "tags": {},
    "isComputeEnabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "rows": 123,
  "stale": 123,
  "indexing": 123
}

Authorizations

Authorization · string · header · required

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

Headers

x-bot-id · string · required

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

table · string · required

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

Response

200

application/json

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

table · object · required

Show child attributes

rows · number · required

The total number of rows present in the table.

stale · number · required

The number of stale rows that are waiting to be processed

indexing · number · required

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