Organizing locations

List all folders under an account in hierarchical structure

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

get/folders/tree

Request

Base URL
https://api.synup.com/api/v4
Auth
none required
TypeScript
https://skmtc.dev/synup/apis/synup-api/docs/folders/tree/get.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Authorizationstring

API key for authentication

Response

Successfully retrieved folder tree structure

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.