Skip to main content

Overview

A Collection is a user-owned, hierarchical folder used to save and organize entities. Every user has a single root collection created automatically on first access. Users can create any number of sub-collections nested under the root or under other sub-collections. Collections are private — each collection belongs to one user and is not visible to others.

Fields

string
Unique identifier for the collection (UUID).
string
The project this collection belongs to.
string
The user who owns this collection.
string | null
The ID of the parent collection. null for the root collection.
string
Display name of the collection. The root collection is always named "root".
number
Number of entities directly saved in this collection (not counting sub-collections).
string (ISO 8601)
Timestamp when the collection was created.
string (ISO 8601)
Timestamp when the collection was last modified.

Notes

  • The root collection is created lazily on the first call to GET /:projectId/api/v7/collections/root.
  • The root collection cannot be renamed or deleted.
  • Sub-collections can be nested to any depth.
  • Entities are linked to collections via a junction table — the same entity can be saved in multiple collections.