Get data schema | Softmax docs

GET/v2/schema

Returns the available tables, columns, and foreign-key relationships.

Authorization

BearerAuth

AuthorizationBearer <token>

Bearer token issued by Softmax

In: header

Query Parameters

include_counts?Include Counts

Include row counts when available.

Defaultfalse

bash

curl -X GET "https://example.com/v2/schema"

json

{
  "tables": [
    {
      "name": "string",
      "row_count": 0,
      "columns": [
        {
          "name": "string",
          "type": "string",
          "nullable": true,
          "default": "string",
          "pk": 0
        }
      ],
      "foreign_keys": [
        {
          "from": "string",
          "to": "string",
          "table": "string",
          "optional": true
        }
      ]
    }
  ]
}