Skip to navigation

Get Single Folder

View as Markdown

Get Single Folder

Retrieves detailed information about a specific folder, including its child folders and files.

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


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_idintegerYesUnique ID of the folder to retrieve

Example:

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

Required Variables

VariableRequiredDescription
base_urlYesBase API URL
access_tokenYesAuthentication access token
folder_idYesID of the folder to retrieve

Sample Request

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

Sample Success Response

A successful request typically returns HTTP 200 OK.

{
"success": true,
"data": {
"id": 11,
"user_id": "43028",
"name": "Campaign Photos",
"parent_id": 10,
"is_system": false,
"file_count": 0,
"created_at": "2026-03-10T06:25:32.000000Z",
"updated_at": "2026-03-10T06:25:32.000000Z",
"deleted_at": null,
"children": [],
"files": []
}
}

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
filesarrayFiles stored inside the folder

Notes

  • The children field contains subfolders inside the current folder.
  • The files field contains files stored in the folder.
  • Useful for building folder view pages in file manager or gallery interfaces.
  • file_count provides a quick summary of how many files exist in the folder.

Response

OK
dataobject
successboolean