---
title: "GET /api/v1/folders/{FolderId}"
method: GET
path: "/api/v1/folders/{FolderId}"
---

# GET /api/v1/folders/{FolderId}

`GET /api/v1/folders/{FolderId}`

Retrieves the metadata of the specified folder.

## Path parameters

- `FolderId` string, required

## Query parameters

- `includeCustomMetadata` boolean

## Headers

- `Authentication` string, password

## Response `200`

Success

- GetFolderResponse
  - `Metadata` object — The metadata of the folder.
    - `Id` string — The ID of the folder.
    - `Name` string, password — The name of the folder.
    - `CreatorId` string — The ID of the creator.
    - `ParentFolderId` string — The ID of the parent folder.
    - `CreatedTimestamp` string, date-time — The time when the folder was created.
    - `ModifiedTimestamp` string, date-time — The time when the folder was updated.
    - `ResourceState` 'ACTIVE' | 'RESTORING' | 'RECYCLING' | 'RECYCLED' — The resource state of the folder.
    - `Signature` string — The unique identifier created from the subfolders and documents of the folder.
    - `Labels` SharedLabel[] — List of labels on the folder.
    - `Size` integer — The size of the folder metadata.
    - `LatestVersionSize` integer — The size of the latest version of the folder metadata.
  - `CustomMetadata` object — The custom metadata on the folder.

## Other responses

- `480` — EntityNotExistsException
- `481` — UnauthorizedOperationException
- `482` — UnauthorizedResourceAccessException
- `483` — InvalidArgumentException
- `484` — FailedDependencyException
- `485` — ServiceUnavailableException
- `486` — ProhibitedStateException

---

[API](https://skmtc.net/aws/apis/workdocs.md) · [All operations](https://skmtc.net/aws/apis/workdocs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/workdocs/versions/8a533af4e1ef/schema)