v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-05-286377631.6 MB
/api/table

GET /api/table/{id}/query_metadata

Get metadata about a Table useful for running queries. Returns DB, fields, field FKs, and field values.

Passing include_hidden_fields=true will include any hidden Fields in the response. Defaults to false Passing include_sensitive_fields=true will include any sensitive Fields in the response. Defaults to false.

Passing include_editable_data_model=true will check that the current user has write permissions for the table's data model, while false checks that they have data access perms for the table. Defaults to false.

These options are provided for use in the Admin Edit Metadata page.

get/api/table/{id}/query_metadata

Path parameters

idinteger required

value must be an integer greater than zero.

Query parameters

include_sensitive_fieldsboolean nullable required
include_hidden_fieldsboolean nullable required
include_editable_data_modelboolean nullable required

Response

Successful response