Workflows

Retrieve a Workflow Document

Download a document associated with a specific workflow via a reference to its document key.

OAuth Scope required: public.workflows.readDocuments

get/workflows/{id}/document/{key}/download

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

keystring required

The unique identifier for the attachment. This key can be located using the Retrieve a Workflow endpoint. In the response, locate the file attribute (e.g., draft) and look at its download parameter. The download parameter includes the key at the end of the URL .../document/{ATTACHMENT_KEY}/download

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Response

200

object required

Changes

No recorded changes to this endpoint across all 1 revision of this API.