GetFolder - Amazon WorkDocs


Retrieves the metadata of the specified folder.

Request Syntax

GET /api/v1/folders/FolderId?includeCustomMetadata=IncludeCustomMetadata HTTP/1.1 Authentication: AuthenticationToken

URI Request Parameters

The request uses the following URI parameters.


Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Length Constraints: Minimum length of 1. Maximum length of 8199.


The ID of the folder.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+-.@]+

Required: Yes


Set to TRUE to include custom metadata in the response.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "CustomMetadata": { "string" : "string" }, "Metadata": { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionSize": number, "ModifiedTimestamp": number, "Name": "string", "ParentFolderId": "string", "ResourceState": "string", "Signature": "string", "Size": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The custom metadata on the folder.

Type: String to string map

Map Entries: Maximum number of 8 items.

Key Length Constraints: Minimum length of 1. Maximum length of 56.

Key Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Value Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*


The metadata of the folder.

Type: FolderMetadata object


For information about the errors that are common to all actions, see Common Errors.


The resource does not exist.

HTTP Status Code: 404


The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.

HTTP Status Code: 424


The pagination marker or limit fields are not valid.

HTTP Status Code: 400


The specified document version is not in the INITIALIZED state.

HTTP Status Code: 409


One or more of the dependencies is unavailable.

HTTP Status Code: 503


The operation is not permitted.

HTTP Status Code: 403


The caller does not have access to perform the action on the resource.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: