Amazon WorkDocs
API Reference (API Version 2016-05-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.

Request Syntax

GET /api/v1/me/root?limit=Limit&marker=Marker HTTP/1.1 Authentication: AuthenticationToken

URI Request Parameters

The request requires the following URI parameters.


Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

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


The maximum number of items to return.

Valid Range: Minimum value of 1. Maximum value of 999.


The marker for the next set of results. (You received this marker from a previous call.)

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

Request Body

The request does not have a request body.

Response Syntax

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

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 user's special folders.

Type: Array of FolderMetadata objects


The marker for the next set of results.

Type: String

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


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


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


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: