v1

latestOpenAPI 3.0.12026-07-2471156164.1 KB
Folders

Create folder

Title is required

post/api/v1/folders

Request body

parentFolderIdstring
prevSiblingItemIdstring

The item id of the item after which this item should be added. May also be 'first' or 'last' to indicate the first or last position respectively. Defaults to 'last' if unspecified.

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

Response

successful operation

idstring

The ID of the directory

itemIdstring
type'folder' required
homeboolean

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

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