MEmetabase
/api/collection

GET /api/collection/root/items/metadata

Changed on

Metadata about the Root Collection's items list: the models with at least one visible item plus the item count. Unlike GET /api/collection/root/items, the result does not depend on search text; pass that endpoint's other scope params so the metadata describes the list being shown.

get/api/collection/root/items/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

Query parameters

modelsstring[] nullable
archivedboolean nullable

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

namespacestring nullable

value must be a non-blank string.

pinned-state'is_not_pinned' | 'is_pinned' | 'all' nullable
collection-type'remote-synced'
include-libraryboolean nullable

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

show-dashboard-questionsboolean nullable

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

show-exploration-documentsboolean nullable

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

Response

Successful response

available_modelsstring[] required
total_itemsinteger required

value must be an integer greater or equal to than zero.

Changes