Skip to main content
GET
/
matters
/
{matterId}
/
documents
/
folders
/
{folderId}
/
path
Get folder path hierarchy
curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/documents/folders/{folderId}/path \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
[
  {
    "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

When request is successful. Returns the folder path hierarchy.

ā€‹
id
string | null

Unique identifier of the folder

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

ā€‹
name
string | null

Name of the folder

Example:

"Property Documents"

ā€‹
parentId
string | null

Unique identifier of the parent folder

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

ā€‹
depth
integer<int32>

The depth of the folder in the folder path hierarchy.

0 indicates the root folder, 1 indicates a direct child of that folder, and so on.

Example:

2