Skip to navigation

Get Folder Breadcrumbs

View as Markdown

Get Folder Breadcrumbs

Retrieves the breadcrumb path for a specific folder.
This helps build navigation showing the folder hierarchy from the root to the selected folder.

Method: GET
URL: {{base_url}}/folders/{{folder_id}}/breadcrumbs


Authentication

This endpoint requires authentication.

Use a Bearer token in the Authorization header:

Authorization: Bearer {{access_token}}

Headers

HeaderValue
AuthorizationBearer {{access_token}}

Path Parameters

ParameterTypeRequiredDescription
folder_idintegerYesID of the folder for which breadcrumbs are required

Example endpoint:

{{base_url}}/folders/{{folder_id}}/breadcrumbs

Required Variables

VariableRequiredDescription
base_urlYesBase API URL
access_tokenYesAuthentication access token
folder_idYesFolder ID to retrieve breadcrumb path

Sample Request

curl --request GET "{{base_url}}/folders/{{folder_id}}/breadcrumbs" \
--header "Authorization: Bearer {{access_token}}"

Sample Success Response

A successful request typically returns HTTP 200 OK.

{
"success": true,
"data": [
{
"id": 9,
"name": "test"
},
{
"id": 10,
"name": "test2"
}
]
}

Response Fields

FieldTypeDescription
idintegerFolder ID in the breadcrumb path
namestringFolder name

Notes

  • The breadcrumb list is returned in hierarchical order.
  • The first item is the top-level parent folder, and the last item is the current folder.
  • Useful for building folder navigation UI, such as:
test / test2

Example UI usage:

breadcrumbs.map(folder => {
return `<a href="/folders/${folder.id}">${folder.name}</a>`;
});

Response

OK
datalist of objects
successboolean