Skip to main content
GET
Download a package as a zip

Authorizations

Authorization
string
header
required

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

Headers

x-workspace-id
string

One of the workspaces the key was issued for, as returned by GET /api/v1/workspaces. Required on a key that acts for members. On any other key it is optional and omitting it acts in the key's default workspace. Any id outside the key's workspaces is rejected with 401.

x-act-as
string

Required on a key that acts for members, refused on any other key. Names the member the call runs as, as key=value: email=jane@acme.com, employee_id=E-1001, scim_external_id=… or a custom identifier. Keys are lowercase and matched case-insensitively. The call fails with 403 when no active member of the workspace matches.

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 as separate files in a zip

The response is of type file.