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
Request
- Base URLhttps://ironcladapp.com/public/api/v1
- URLhttps://ironcladapp.com/public/api/v1/workflows/{id}/document/{key}/download
- AuthAPI key in header Authorization and OAuth 2Authorization code: https://ironcladapp.com/oauth/authorizeClient credentialsToken URL: https://ironcladapp.com/oauth/token scopes: public.workflows.readDocuments
Path parameters
The unique identifier or Ironclad ID of a workflow.
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
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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.
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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.
Response
200
Changes
No recorded changes to this operation across all 2 revisions of this API.