Get Table Schema

GET /api/database/tables/{tableName}/schema

Get Table Schema

cURL

curl --request GET \
  --url https://api.example.com/api/database/tables/{tableName}/schema \
  --header 'Authorization: Bearer <token>'

200

{
  "tableName": "posts",
  "columns": [
    {
      "name": "id",
      "type": "uuid",
      "nullable": false,
      "unique": true,
      "default": "gen_random_uuid()",
      "isPrimaryKey": true,
      "foreignKey": null
    },
    {
      "name": "title",
      "type": "string",
      "nullable": false,
      "unique": false,
      "default": null,
      "isPrimaryKey": false,
      "foreignKey": null
    },
    {
      "name": "userId",
      "type": "uuid",
      "nullable": false,
      "unique": false,
      "default": null,
      "isPrimaryKey": false,
      "foreignKey": {
        "table": "auth.users",
        "column": "id",
        "on_delete": "CASCADE"
      }
    }
  ]
}

Authorizations

bearerAuthapiKey

Authorization · string · header · required

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

Path Parameters

tableName · string · required

Response

200

application/json

Table schema

table_name · string

columns · object[]

Show child attributes