Objects

Folder

A folder of a collection. sort_key orders the folder among its siblings (compared as a string), permissions lists the current user's effective permissions on the folder, and color and icon set its appearance.

Fields

idstringrequired
collection_idintegerrequired
parent_idstring | nullrequired
titlestringrequired
sort_keystringrequired
created_byinteger | nullrequired
created_atstring (date-time)required
updated_atstring (date-time)required
colorFolderColor | nullrequired
Folder color from the palette, the same for all users. null means automatic: the client picks a palette color based on the name.
iconFolderIcon | nullrequired
Folder icon, the same for all users. null means automatic, based on the top_category of the tree node.
permissionsarray of stringrequired
metadataMetadata

Used by

POST/v1/collections/{name}/foldersCreate a folder
PATCH/v1/folders/{folder_id}Rename, move or reorder a folder

Part of

CardExpanded FolderNode FolderWithPath