Skip to navigation

Get Folders List

View as Markdown

Get Folders List

Retrieves the list of folders for the authenticated user.
You can optionally filter folders by parent folder ID.

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


Authentication

This endpoint requires authentication.

Use a Bearer token in the Authorization header:

Authorization: Bearer {{access_token}}

Headers

HeaderValue
AuthorizationBearer {{access_token}}

Query Parameters

ParameterTypeRequiredDescription
parent_idintegerNoFilter folders by parent folder ID. If omitted, returns all folders or root folders depending on implementation.

Example:

{{base_url}}/folders?parent_id={{parent_id}}

Required Variables

VariableRequiredDescription
base_urlYesBase API URL
access_tokenYesAuthentication access token
parent_idNoParent folder ID used for filtering

Sample Request

curl --request GET "{{base_url}}/folders?parent_id={{parent_id}}" \
--header "Authorization: Bearer {{access_token}}"

Sample Success Response

A successful request typically returns HTTP 200 OK.

{
"success": true,
"data": [
{
"id": 8,
"user_id": "43028",
"name": "Campaign Photos",
"parent_id": 5,
"is_system": false,
"file_count": 2,
"created_at": "2026-03-09T11:24:52.000000Z",
"updated_at": "2026-03-09T13:27:18.000000Z",
"deleted_at": null,
"children": []
},
{
"id": 9,
"user_id": "43028",
"name": "test",
"parent_id": null,
"is_system": false,
"file_count": 1,
"created_at": "2026-03-09T13:09:49.000000Z",
"updated_at": "2026-03-10T06:23:09.000000Z",
"deleted_at": null,
"children": [
{
"id": 10,
"user_id": "43028",
"name": "test2",
"parent_id": 9,
"is_system": false,
"file_count": 14,
"created_at": "2026-03-09T13:10:07.000000Z",
"updated_at": "2026-03-10T05:34:50.000000Z",
"deleted_at": null
}
]
},
{
"id": 10,
"user_id": "43028",
"name": "test2",
"parent_id": 9,
"is_system": false,
"file_count": 14,
"created_at": "2026-03-09T13:10:07.000000Z",
"updated_at": "2026-03-10T05:34:50.000000Z",
"deleted_at": null,
"children": []
}
]
}

Response Fields

FieldTypeDescription
idintegerFolder ID
user_idstringOwner user ID
namestringFolder name
parent_idinteger/nullParent folder ID
is_systembooleanIndicates if it is a system folder
file_countintegerNumber of files in the folder
created_atdatetimeFolder creation timestamp
updated_atdatetimeLast update timestamp
deleted_atdatetime/nullSoft delete timestamp
childrenarrayList of child folders

Notes

  • The children field contains nested subfolders.
  • parent_id = null indicates a root-level folder.
  • Useful for building folder tree structures in file manager UIs.
  • The file_count field indicates how many files exist in each folder.

Response

OK
datalist of objects
successboolean