Sign in
Folders

Get folder path hierarchy

Returns the full folder hierarchy (path) as a collection ordered from the root folder down to the supplied folder.

The root folder is not included in the response.

get/matters/{matterId}/documents/folders/{folderId}/path

Path parameters

matterIdstring required

Unique identifier of the matter.

folderIdstring required

Unique identifier of the folder.

Response

When request is successful. Returns the folder path hierarchy.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Example response

{
  "value": [
    {
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "name": "Property Documents",
      "parentId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
      "depth": 2
    }
  ]
}

Changes

Changed in 1 of the 5 revisions of this API.1