List all folders under an account in hierarchical structure

GET

https://api.synup.com/api/v4/folders/tree

This API retrieves a complete hierarchical tree of all active folders within an account.

Response Includes:

Folder hierarchy levels (parent and nested subfolders)

Location count within each folder

Nested subfolder details for a structured view

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.synup.com/api/v4/folders/tree' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx'

Responses

🟢200OK

application/json

Successfully retrieved folder tree structure

Body

Example

{
    "data": {
        "getFolderTree": [
            {
                "id": "67049f29-3bc6-4e82-875b-02159b4b1fea",
                "name": "root",
                "level": 0,
                "locationCount": 25,
                "subFolders": [
                    {}
                ]
            }
        ]
    }
}

Modified at 2025-05-26 13:01:51

List all folders

Get details of a folder