List Documents

Retrieve the complete document library metadata for the target. Requires authentication, the DOCUMENTS feature flag, and ADMIN or MANAGE_DOCUMENTS permissions.

Parameters

No query parameters or request body are used. limit and offset are ignored; this endpoint does not paginate.

Return Value

HTTP 200 OK. The JSON body contains message and data. data is a MetaDocumentsDocument object with count, unpublishedCount, and a nested data map keyed by document ID. Each map value is a DocumentRefEntry, including title, state, version, draftVersion, parent information, and available access/publication metadata. Entries are metadata, not full document content.

If the metadata record does not exist, the response is:

{
  "message": "Document library structure retrieved successfully",
  "data": {
    "count": 0,
    "unpublishedCount": 0,
    "data": {}
  }
}

Examples

bash

curl "https://app.wombat.software/api/{targetPath}/documents" \
  -H "Authorization: Bearer ..."