MEmetabase
/api/database

GET /api/database/{id}/schema

Changed on

Return a list of Tables for a Database whose schema is the schema query parameter, or nil or an empty string when no schema is given. Unlike the /:id/schema/:schema route, the query parameter supports schema names containing slashes, which are rejected at the HTTP layer when percent-encoded in the URL path (#77353).

Optional filters:

  • can-query=true - filter to only tables the user can query
get/api/database/{id}/schema

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Path parameters

idinteger required

value must be an integer greater than zero.

Query parameters

schemastring nullable
include_hiddenboolean nullable

value must be a valid boolean string ('true' or 'false').

include_editable_data_modelboolean nullable

value must be a valid boolean string ('true' or 'false').

can-queryboolean nullable
include_measuresboolean nullable

Response

Successful response

Changes

  • 2e178f5a7934Revision changes
    • warning

      deleted the query request parameter can-write-metadata

    • info

      added the new optional query request parameter schema

    • info

      the query request parameter include_editable_data_model became optional

    • info

      the query request parameter include_hidden became optional

  • b1dc4ea67567Revision changes
    • info

      added the new optional query request parameter include_measures