/api/collection
GET /api/collection/{id}/items
Fetch a specific Collection's items with the following options:
- models - only include objects of a specific set of models. If unspecified, returns objects of all models
- archived - when true, return archived objects instead of unarchived ones. Defaults to false.
- pinned_state - when is_pinned, return pinned objects only. when is_not_pinned, return non pinned objects only. when all, return everything. By default returns everything.
- include_can_run_adhoc_query - when this is true hydrates the can_run_adhoc_query flag on card models
Note that this endpoint should return results in a similar shape to /api/dashboard/:id/items, so if this is changed, that should too.
get/api/collection/{id}/items
Path parameters
Query parameters
modelsstring[] nullable
archivedboolean nullable required
include_can_run_adhoc_queryboolean nullable required
pinned_state'is_not_pinned' | 'is_pinned' | 'all' nullable
sort_column'model' | 'name' | 'last_edited_by' | 'last_edited_at' | 'description' nullable
sort_direction'desc' | 'asc' nullable
official_collections_firstboolean nullable
show_dashboard_questionsboolean nullable required
Response
Successful response