Documents Plugin

Retrieve a paginated, filtered list of documents.

GET

http://localhost:3000/api/plugins/docs/documents

curl -X GET 'http://localhost:3000/api/plugins/docs/documents'

const response = await fetch('http://localhost:3000/api/plugins/docs/documents', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('http://localhost:3000/api/plugins/docs/documents')
print(response.text)

Parameters

selectObjectquery

relationsObjectquery

whereObjectrequiredquery

orderObjectquery

withDeletedbooleanquery

takenumber[0, 100]query

skipnumber>= 0query

kindArray<string>FOLDERPAGEFILEquery

statusArray<string>UPLOADEDPROCESSINGREADYFAILEDquery

knowledgeStatusArray<string>NONEQUEUEDINDEXINGINDEXEDFAILEDEXCLUDEDquery

reviewStatusArray<string>NONEPENDINGAPPROVEDREJECTEDquery

needsReviewbooleanquery

sourceArray<string>UPLOADEDITORCHATEMAILINTEGRATIONSYSTEMIMPORTquery

categoryIdsArray<string>query

tagIdsArray<string>query

visibilitystringORGANIZATIONPRIVATEquery

archivedstringexcludeincludeonlyquery

searchablebooleanquery

createdAtFromstringquery

createdAtTostringquery

updatedAtFromstringquery

updatedAtTostringquery

parentIdstringquery

Parent id or 'root'

qstringquery

searchInstringnamecontentquery

sortstringnameupdatedAtcreatedAtsizekindquery

sortOrderstringASCDESCquery

200OK

List of documents retrieved successfully.