VUZDevelopers

Export documents (ZIP / Excel / CSV) for download

POST
/documents/export

Builds and streams an export of the documents matching the given scope/filters, in the requested format — a ZIP of the signed PDFs, or an Excel/CSV summary sheet. The response is the binary file with a Content-Disposition attachment filename (RFC 5987 UTF-8 so Hebrew filenames survive). Brand-restricted users only export their own brand. Requires the documents:read scope and the x-business-id header.

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/documents/export" \  -H "Content-Type: application/json" \  -d '{}'
Empty