List all folders

GET

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

This API returns a flat list of all active folders accessible to the user.

Response Includes:

Basic folder information (ID, name)

Parent folder details (if applicable)

Number of locations within each folder

Hierarchy level of each folder

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/flat' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json'

Responses

🟢200OK

application/json

Successfully retrieved folders list

Body

Example

{
    "data": {
        "getUserFolders": [
            {
                "id": "401228fe-8ee9-4914-a08a-db7cda490ec9",
                "level": 0,
                "locationCount": 2749,
                "name": "root",
                "parentFolderId": null,
                "parentFolderName": null
            },
            {
                "id": "0360d778-1bfb-4795-8c11-b278f3a65970",
                "level": 1,
                "locationCount": 1,
                "name": "demo_1",
                "parentFolderId": "401228fe-8ee9-4914-a08a-db7cda490ec9",
                "parentFolderName": "root"
            }
        ]
    }
}

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

Create a new folder

List all folders under an account in hierarchical structure