Skip to content

List Documents

List document metadata for the target path. Requires the DOCUMENTS feature flag and ADMIN or MANAGE_DOCUMENTS permissions.

Parameters

name * are required parametersdata typedescription
limitnumberMaximum number of results to retrieve
offsetnumberOffset from the first index in the collection

Return Value

json
{
  "statusCode": 200,
  "message": "search completed",
  "data": [DocumentMeta, DocumentMeta, ...]
}

Examples

bash
curl "https://app.wombat.software/api/{targetPath}/documents?limit=20" \
  -H "Authentication: Bearer ..."

ENDPOINTS

get/api/{targetPath}/documents