Skip to content
Sursa Developers

Objects

FolderNode

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
  • cardsintegerrequired

    Number of cards in the folder itself (without subfolders) that are available to the user. Archived cards are not counted, as in the default card list.

  • cards_totalintegerrequired

    Unique cards of the folder and all its subfolders that are available to the user, without archived cards (a card in two subfolders is counted once).

  • sensitive_totalintegerrequired

    How many of cards_total are restricted cards (sensitive). Archived cards are not counted.

  • top_categorystring | nullrequired

    The category that most cards of cards_total belong to (on a tie, the smaller key; archived cards are not counted). null if there are no cards. The client uses it to choose the folder icon when icon: null.

  • childrenarray of FolderNoderequired

Part of

FolderTree