Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444236171.7 KB

Searches metadata and the content of folders, documents, document versions, and comments.

post/api/v1/search

Query parameters

Limitstring

Pagination limit

Markerstring

Pagination token

Headers

Authenticationstring password

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

Request body

QueryTextstring password

The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.

QueryScopesSearchQueryScopeType[]

Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content

OrganizationIdstring

Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.

AdditionalResponseFieldsAdditionalResponseFieldType[]

A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.

Limitinteger

Max results count per page.

Markerstring

The marker for the next set of results.

Response

Success

Markerstring

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.