IRironcladapp
Workflows

Retrieve Documents from a Workflow

Changed on

Retrieve all documents from a workflow that are included and excluded from the signature packet.

OAuth Scope required: public.workflows.readDocuments

get/workflows/{id}/documents

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/workflows/{id}/documents
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.workflows.readDocuments

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

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. 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.

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. 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

Example response

{
  "signaturePacketDocuments": [
    {
      "version": "B1QePArXb",
      "versionNumber": 2,
      "filename": "file.pdf",
      "key": "rJklwCHQ",
      "download": "/public/api/v1/workflows/594356b9fbcd7f74006fdf8a/document/rJklwCHQ/download",
      "lastModified": {
        "timestamp": "2016-11-17T00:37:22.318Z",
        "author": {
          "type": "internalUser",
          "companyName": "Jabba the Hutt Industries",
          "displayName": "Boba Fett",
          "email": "boba@example.com",
          "userId": "63d415e0dd0d828c3a878548"
        }
      },
      "fileHash": "2fd4e1c67a2d28fced849ee1bb76e7391b93eb12",
      "hashAlgorithm": "sha1"
    }
  ],
  "excludedFromSignaturePacketDocuments": [
    {
      "version": "B1QePArXb",
      "versionNumber": 2,
      "filename": "file.pdf",
      "key": "rJklwCHQ",
      "download": "/public/api/v1/workflows/594356b9fbcd7f74006fdf8a/document/rJklwCHQ/download",
      "lastModified": {
        "timestamp": "2016-11-17T00:37:22.318Z",
        "author": {
          "type": "internalUser",
          "companyName": "Jabba the Hutt Industries",
          "displayName": "Boba Fett",
          "email": "boba@example.com",
          "userId": "63d415e0dd0d828c3a878548"
        }
      },
      "fileHash": "2fd4e1c67a2d28fced849ee1bb76e7391b93eb12",
      "hashAlgorithm": "sha1"
    }
  ]
}

Changes

  • 435da5a4396eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status