pb.folders

Folders are saved collections that use howl tags. Use pb.folders to create and manage folders for the signed-in user. You can also list the visible folders of another user if you know the user ID.

List folders

const { folders } = await pb.folders.list('user-id')

Pass the profile UUID. Do not pass a username. The endpoint requires this target user ID when you list your folders.

Create and update

const { folder } = await pb.folders.create({
  name: 'Landscapes',
  emoji: '🏞️',
  query: 'art,landscape',
})

await pb.folders.update(folder.id, {description: 'Landscape references'})

name is the visible folder name. description and emoji are optional display data. query is a comma-separated list of tags such as 'art,landscape'. Each account can create a maximum of 10 folders.

Fetch and delete

const detail = await pb.folders.get(folderId)
console.log(detail.folder.name, detail.profile.username)

await pb.folders.delete(folderId)

get() returns an object that contains folder and the owner's profile. It does not return only the folder. Only the owner can update or delete the folder.

Add and remove howls

await pb.folders.addHowl('folder-id', 'howl-id')
await pb.folders.removeHowl('folder-id', 'howl-id')

addHowl() sends the howl ID in the documented POST body. removeHowl() encodes both IDs in the DELETE path.