v1

latestOpenAPI 3.0.12026-07-2471156164.1 KB

Folders

Get folder

Including a Folder's ID will load information about a single folder with its cards and sections. With this call, you can also return a 'Home Folder', which is what we call the structure that lists what Folders exist within a collection. To return this information, set the folderId to homeBoardSlug from the collection's response

get/api/v1/folders/{folderId}

Path parameters

folderIdstring required

The ID of the Folder

Query parameters

collectionstring

The ID of the collection

Headers

X-Guru-ActivitySubTypestring

X-Guru-Applicationstring

X-Guru-ActivityIDstring

Response

successful operation

homeboolean

Indicates if this folder is the top level folder for the collection

idstring

The ID of the directory

lastModifiedstring date-time

The date that the directory was last modified

groupsSharedWithstring[]

Returns the groups that a directory is shared with

slugstring

The slug is the URL address to the directory

numberOfFactsinteger

The number of cards in the directory

favoritedDatestring date-time

When this directory has been favorited by the current user

favoritedboolean

Whether this board has been favorited by the current user

descriptionstring

An optional short description of the directory

titlestring

The title of the directory