Skip to main content
GET
Download a package as one PDF

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-workspace-id
string

The workspace the key was issued for, as returned by GET /api/v1/workspaces. Optional: omitting it acts in the key's workspace, and any other id is rejected with 401.

Path Parameters

packageId
string
required

Query Parameters

documents
string

A comma-separated list of document ids to include. Omit it for every document in the package.

Example:

"cmg4v8q2k0003s7xhq1w8n5r7,cmg4v8q2k0004s7xhm3c5v7b9"

certificate
enum<string>

"true" appends the certificate of completion, which only a completed package has; "false", or omitting it, leaves it out.

Available options:
true,
false
Example:

"true"

Response

The package's documents, merged into a single PDF

The response is of type file.