v12

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

GET /api/collection/root/items

Fetch objects that the current user should see at their root level. As mentioned elsewhere, the 'Root' Collection doesn't actually exist as a row in the application DB: it's simply a virtual Collection where things with no collection_id exist. It does, however, have its own set of Permissions.

This endpoint will actually show objects with no collection_id for Users that have Root Collection permissions, but for people without Root Collection perms, we'll just show the objects that have an effective location of /.

This endpoint is intended to power a 'Root Folder View' for the Current User, so regardless you'll see all the top-level objects you're allowed to access.

By default, this will show the 'normal' Collections namespace; to view a different Collections namespace, such as snippets, you can pass the ?namespace= parameter.

By default, library collections are excluded from the results; to include them, pass ?include_library=true.

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/root/items

Query parameters

modelsstring[] nullable
collection_type'remote-synced'
include_can_run_adhoc_queryboolean nullable required
archivedboolean nullable required
namespacestring nullable
include_libraryboolean 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

Response

Successful response