Search for documents within a defined document folder.
Version 2.0.0
Endpoint
GET
undefined/search/documents
Copy
Allows to search documents, based on a query sent, on all documentGroups associated with the specified documentFolder, resulting zero to many metadata items related to uploaded documents, each with all its details.
Query Parameters
- folderNamestringRequireddocumentFolder name to search by - either folderName or groupName are required - not both
- groupNamestringdocumentGroup name to search by - either folderName or groupName are required - not both
- $filterstringRequiredoData (See AID) to search by. When documentGroup is passed the field names are the group's, when the folderName is provided, the field names are the searchNames defined in the documentFolder.
- $limitintRequiredNumber of results to return (up to 10,000).
- invisibleOnlybooleanOptional: when true: Shows only document metadata items marked as invisible.When false (default), shows only documents marked as visible true..
Body Parameters
Responses
successful operation.
Body
application/json
- objectRequired
- hasMorebooleanWhen true, specifies that there are more results for this query than the $limit.Example: true
- resultsarray of objectsRepresents a single document (metadata item) + additional information such as built-in fields.