> ## Documentation Index
> Fetch the complete documentation index at: https://replyke-feat-push-rich-payload-fields.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Collections
> Organize a user's saved entities into a tree of collections from your server
The `collections` module manages a user's saved-content collections. Every user has a single **root collection**, under which they can nest sub-collections and into which they can save entities.
Collections are always scoped to a specific user. Pass that user's Sublay ID as
`userId` on every call — your service key performs the operation on behalf of
that named user.
***
### fetchRootCollection
Fetches a user's root collection, creating it on first access if it does not yet exist.
```typescript theme={null}
const root = await sublay.collections.fetchRootCollection({
userId: "usr_abc123",
});
```
The Sublay user ID whose root collection to fetch.
**Returns** — `Promise`
***
### fetchSubCollections
Fetches the direct child collections nested under a given collection.
```typescript theme={null}
const subCollections = await sublay.collections.fetchSubCollections({
collectionId: "col_root123",
userId: "usr_abc123",
});
```
The parent collection ID.
The Sublay user ID who owns the collection.
**Returns** — `Promise`
***
### createNewCollection
Creates a new sub-collection under an existing parent collection.
```typescript theme={null}
const collection = await sublay.collections.createNewCollection({
collectionId: "col_root123",
collectionName: "Recipes",
userId: "usr_abc123",
});
```
The parent collection under which to create the sub-collection.
The name of the new collection.
The Sublay user ID who will own the collection.
**Returns** — `Promise`
***
### fetchCollectionEntities
Fetches a paginated list of entities saved in a collection.
```typescript theme={null}
const { data, pagination } = await sublay.collections.fetchCollectionEntities({
collectionId: "col_xyz789",
userId: "usr_abc123",
sortBy: "added",
page: 1,
limit: 20,
});
```
The collection ID.
The Sublay user ID who owns the collection.
Page number (1-indexed). Defaults to `1`.
Results per page. Defaults to `20`.
Sort order: `"new"`, `"added"` (when saved), `"top"`, or `"hot"`.
Sort direction: `"asc"` or `"desc"`.
Comma-separated list of associations to populate (e.g. `"user"`).
**Returns** — `Promise>`
***
### addEntityToCollection
Saves an entity into a collection.
```typescript theme={null}
const collection = await sublay.collections.addEntityToCollection({
collectionId: "col_xyz789",
entityId: "ent_xyz789",
userId: "usr_abc123",
});
```
The collection to add the entity to.
The Sublay entity ID to save.
The Sublay user ID who owns the collection.
**Returns** — `Promise`
***
### removeEntityFromCollection
Removes an entity from a collection.
```typescript theme={null}
await sublay.collections.removeEntityFromCollection({
collectionId: "col_xyz789",
entityId: "ent_xyz789",
userId: "usr_abc123",
});
```
The collection to remove the entity from.
The Sublay entity ID to remove.
The Sublay user ID who owns the collection.
**Returns** — `Promise`
***
### updateCollection
Renames a collection.
```typescript theme={null}
const collection = await sublay.collections.updateCollection({
collectionId: "col_xyz789",
userId: "usr_abc123",
name: "Favorite Recipes",
});
```
The collection ID to update.
The Sublay user ID who owns the collection.
The new collection name.
**Returns** — `Promise`
***
### deleteCollection
Deletes a collection.
```typescript theme={null}
await sublay.collections.deleteCollection({
collectionId: "col_xyz789",
userId: "usr_abc123",
});
```
The collection ID to delete.
The Sublay user ID who owns the collection.
**Returns** — `Promise`