listTables

Retrieves a list of all tables associated with your bot.

GET /v1/tables

cURL

cURL

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

200

{
  "tables": [
    {
      "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"
    }
  ]
}

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

Query Parameters

tags · object

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

Show child attributes

Response

200

application/json

Returns a list of tables.

tables · object[] · required

Show child attributes