---
title: "List all folders"
method: GET
path: "/folders/flat"
tags: ["Organizing locations", "Folders"]
---

# List all folders

`GET /folders/flat`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/folders/flat`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/folders/flat/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Headers

- `Authorization` string
- `Content-Type` string

## Response `200`

Successfully retrieved folders list

- ListFoldersResponse
  - `data` object
    - `getUserFolders` FolderInfoV2[]
      - `id` string, uuid: Unique identifier of the folder
      - `name` string: Name of the folder
      - `level` integer: Hierarchical level of the folder (0 for root)
      - `locationCount` integer: Number of locations in this folder
      - `parentFolderId` string, uuid, nullable: ID of the parent folder (null for root folder)
      - `parentFolderName` string, nullable: Name of the parent folder (null for root folder)

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)