folder

Get Folder

Changed on

Returns a single decorated Folder including sharing, usage and buttons

get/folders/{folderId}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/folders/{folderId}
  • Auth
    none declared

Path parameters

folderIdinteger required

The ID of the Folder to return

Query parameters

folderNamestring

Filter by Folder name

exactFolderNameinteger

Filter by exact Folder name match

homeFolderIdinteger

Override the home folder ID used when building the tree view

Response

successful operation

idinteger

The ID of this Folder

typestring

The type of folder (home or root)

textstring

The name of this Folder

parentIdinteger

The folderId of the parent of this Folder

isRootinteger

Flag indicating whether this is root Folder

childrenstring

An array of children folderIds

createdDtstring nullable

Date this Folder was created

modifiedDtstring nullable

Date this Folder was last modified

Changes