MEmetabase
/api/collection

GET /api/collection/{id}/items/metadata

Changed on

Metadata about the collection's items list: the models with at least one visible item plus the item count. Unlike GET /api/collection/:id/items, the result does not depend on search text; pass that endpoint's other scope params -- models, archived, pinned-state, show-dashboard-questions, show-exploration-documents -- so the metadata describes the list being shown.

get/api/collection/{id}/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

Path parameters

integer required

value must be an integer greater than zero.

OR
string required

String must be a valid 21-character NanoID string.

Query parameters

modelsstring[] nullable
archivedboolean nullable

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

pinned-state'is_not_pinned' | 'is_pinned' | 'all' nullable
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