v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444236171.7 KB

Retrieves details of a document.

get/api/v1/documents/{DocumentId}

Path parameters

DocumentIdstring required

The ID of the document.

Query parameters

includeCustomMetadataboolean

Set this to <code>TRUE</code> to include custom metadata in the response.

Headers

Authenticationstring password

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

Response

Success

CustomMetadataobject

The custom metadata on the document.