Skip to main content
GET
Get a destination

Authorizations

Authorization
string
header
required

Your secret key as a bearer token, e.g. Authorization: Bearer sk_live_…. Secret keys are server-side only.

Path Parameters

id
string
required

The destination id.

Response

OK

destination
Destination · object

Where a job's finished, print-ready files go once the job completes successfully. A destination is a reusable Library record: a workflow lists the destinations it delivers to in workflow.delivery.destinationIds (and only delivers while workflow.delivery.enabled is not false), and one destination can serve any number of workflows. kind picks the transport and params holds that transport's settings: email (download links mailed out), webhook (a JSON POST with download links, e.g. into Zapier), or one of the hotfolder kinds s3, sftp and ftp, which copy the files themselves into a folder the print shop's prepress or MIS system watches. Delivery runs once per job, after the job reaches done (never for previews or failed jobs); each destination is tried once and a failure on one does not stop the others. Files are named after the product (e.g. Business_Cards.pdf, or Business_Cards-1.pdf, Business_Cards-2.pdf when a job has several). Secret params (sftp/ftp password, sftp privateKey and passphrase, webhook headerValue) are write-only: send them as plain strings and they are encrypted on save; they read back masked as ********, and sending ******** back unchanged keeps the stored value. Use the destination test action to send a sample delivery (a one-page Sample_Product.pdf for order TEST-1001) through the real transport before pointing a workflow at it. Changing kind on an existing destination: also null out the old kind's params (JSON Merge Patch keeps keys you don't send).