MEmetabase
/api/table

GET /api/table/{id}/query_metadata

Changed on

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 if the current user has data model editing permissions for the table. Defaults to false.

Passing include_editable_data_model=true will check that the current user has data model editing permissions for the table, even when Remote Sync makes the table read-only, while false checks that they can read the table. Defaults to false.

The response includes can_write, which is false when the user cannot edit the table's metadata right now.

These options are provided for use in the data model pages.

get/api/table/{id}/query_metadata

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

include_sensitive_fieldsboolean nullable

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

include_hidden_fieldsboolean 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').

Response

Successful response

Changes

  • 2e178f5a7934Revision changes
    • info

      the query request parameter include_editable_data_model became optional

    • info

      the query request parameter include_hidden_fields became optional

    • info

      the query request parameter include_sensitive_fields became optional

  • 78297d193ca4Revision changes
    • info

      api operation id get-api-table-id-query_metadata was added