v12

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

GET /api/search

Search for items in Metabase. For the list of supported models, check [[metabase.search.config/all-models]].

Filters:

  • archived: set to true to search archived items only, default is false
  • table_db_id: search for tables, cards, and models of a certain DB
  • models: only search for items of specific models. If not provided, search for all models
  • filters_items_in_personal_collection: only search for items in personal collections
  • created_at: search for items created at a specific timestamp
  • created_by: search for items created by a specific user
  • last_edited_at: search for items last edited at a specific timestamp
  • last_edited_by: search for items last edited by a specific user
  • search_native_query: set to true to search the content of native queries
  • verified: set to true to search for verified items only (requires Content Management or Official Collections premium feature)
  • ids: search for items with those ids, works iff single value passed to models
  • display_type: search for cards/models with specific display types
  • non_temporal_dim_ids: search for cards/metrics/datasets with this exact set of non temporal dimension field IDs (requires appdb engine)
  • has_temporal_dim: set to true for cards/metrics/datasets with 1 or more temporal dimensions (requires appdb engine)

Note that not all item types support all filters, and the results will include only models that support the provided filters. For example:

  • The created-by filter supports dashboards, models, actions, and cards.
  • The verified filter supports models and cards.

A search query that has both filters applied will only return models and cards.

get/api/search

Query parameters

qstring nullable
contextstring nullable
archivedboolean nullable required
collectioninteger nullable

value must be an integer greater than zero.

table_db_idinteger nullable

value must be an integer greater than zero.

modelsstring[] nullable
filter_items_in_personal_collection'all' | 'only' | 'only-mine' | 'exclude' | 'exclude-others' nullable
created_atstring nullable
created_byinteger[] nullable
display_typestring[] nullable
last_edited_atstring nullable
last_edited_byinteger[] nullable
model_ancestorsboolean nullable required
search_enginestring nullable
search_native_queryboolean nullable
verifiedboolean nullable
idsinteger[] nullable
calculate_available_modelsboolean nullable
include_dashboard_questionsboolean nullable required
include_metadataboolean nullable required
non_temporal_dim_idsstring nullable
has_temporal_dimboolean nullable

Response

Successful response