/api/database
GET /api/database/{id}/metadata
Get metadata about a Database, including all of its Tables and Fields. Returns DB, fields, and field values. By default only non-hidden tables and fields are returned. Passing include_hidden=true includes them.
Passing include_editable_data_model will only return tables for which the current user has data model editing permissions, if Enterprise Edition code is available and a token with the advanced-permissions feature is present. In addition, if the user has no data access for the DB (aka block permissions), it will return only the DB name, ID and tables, with no additional metadata.
get/api/database/{id}/metadata
Path parameters
idinteger required
value must be an integer greater than zero.
Query parameters
include_hiddenboolean nullable required
include_editable_data_modelboolean nullable required
remove_inactiveboolean nullable required
skip_fieldsboolean nullable required
Response
Successful response