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

Get folder path hierarchy

cURL

curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/documents/folders/{folderId}/path \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

200

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "name": "Property Documents",
      "parentId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
      "depth": 2
    }
  ]
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

matterId · string · required

folderId · string · required

Response

200

application/json

When request is successful. Returns the folder path hierarchy.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object

Show child attributes

value · object[] | null

Show child attributes