Sign in
folder

Search Folders

Returns JSON representation of the Folder tree

get/folders

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

Changed in 6 of the 52 revisions of this API.339

  • fe497e811c7f123See the full diff
    • ▲

      added the new path request parameter folderId

      new-request-path-parameter

    • ●

      deleted the query request parameter folderId

      request-parameter-removed

    • ●

      deleted the query request parameter gridView

      request-parameter-removed

    • ○

      added the new optional query request parameter homeFolderId

      new-optional-request-parameter

    • ○

      added the optional property items/createdDt to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/modifiedDt to the response with the 200 status

      response-optional-property-added

  • 41c04de98ec511See the full diff
    • ●

      deleted the path request parameter folderId

      request-parameter-removed

    • ○

      added the media type application/json for the response with the status 200

      response-media-type-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • fa8d95dfe4bb1See the full diff
    • ○

      added the new optional query request parameter exactFolderName

      new-optional-request-parameter

  • 6754c288e29a13See the full diff
    • ▲

      added the new path request parameter folderId

      new-request-path-parameter

    • ○

      added the new optional query request parameter folderId

      new-optional-request-parameter

    • ○

      added the new optional query request parameter folderName

      new-optional-request-parameter

    • ○

      added the new optional query request parameter gridView

      new-optional-request-parameter

  • 23e8e640f5241See the full diff
    • ○

      endpoint added

      endpoint-added

  • 8e12753951041See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog