listTables

Retrieves a list of all tables associated with your bot.

GET/v1/tables

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

Query parameters

tags?object

Optional filters to narrow down the list by tags associated with tables.

Response

Returns a list of tables.

tablesobject[]

Request

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

Response

{
  "tables": [
    {
      "id": "string",
      "name": "string",
      "factor": 1,
      "frozen": true,
      "keyColumn": "string",
      "schema": {
        "$schema": "string",
        "properties": {
          "key": {}
        },
        "additionalProperties": true,
        "required": [
          "string"
        ],
        "type": "object"
      },
      "tags": {
        "key": "string"
      },
      "isComputeEnabled": true,
      "createdAt": "2025-01-15T12:00:00Z",
      "updatedAt": "2025-01-15T12:00:00Z"
    }
  ]
}