/api/v1/search
http://workdocs.{region}.amazonaws.com/api/v1/searchSearches metadata and the content of folders, documents, document versions, and comments.
Query Params
Pagination limit
Pagination token
Body Params
Max results count per page.
The marker for the next set of results.
Filters results based on entity metadata.
Order by results in one or more categories.
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.
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
Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.
A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}1curl --request POST \2 --url 'http://workdocs.{region}.amazonaws.com/api/v1/search' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}