---
title: "Get details of a folder"
method: GET
path: "/folder-details"
tags: ["Organizing locations"]
---

# Get details of a folder

`GET /folder-details`

## Request

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

This API retrieves detailed information about a specific folder.

**Response Includes:**
- Folder details (ID, name)
- Parent folder information (if applicable)
- Creation date

:::info[]

Note: Either folderId or folderName must be provided as a query parameter.

:::

## Query parameters

- `folderId` string, uuid
- `folderName` string

## Headers

- `Authorization` string

## Response `200`

Successfully retrieved folder details

- object
  - `data` object
    - `getFolderDetails` object
      - `locations` object[], required: List of locations in the folder
      - `folderName` string, required: Name of the folder
      - `parentFolderId` string, uuid, required: Unique identifier of the parent folder
      - `parentFolderName` string, required: Name of the parent folder
      - `createdAt` string, date-time, required: Creation timestamp of the 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)