GET
/api/v1/folders/{FolderId}/contents
http://workdocs.{region}.amazonaws.com/api/v1/folders/{FolderId}/contents<p>Describes the contents of the specified folder, including its documents and subfolders.</p> <p>By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.</p>
Access Token Required: API Key
Path Parameters
FolderIdstringrequired
The ID of the folder.
Query Params
sortstring
The sorting criteria.
Allowed:
orderstring
The order for the contents of the folder.
Allowed:
limitinteger
The maximum number of items to return with this call.
markerstring
The marker for the next set of results. This marker was received from a previous call.
typestring
The type of items.
Allowed:
includestring
The contents to include. Specify "INITIALIZED" to include initialized documents.
Limitstring
Pagination limit
Markerstring
Pagination token
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request GET \2 --url 'http://workdocs.{region}.amazonaws.com/api/v1/folders/{FolderId}/contents' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}