IRironcladapp
Workflows

Retrieve a Workflow

Changed on

View the data associated with a specific workflow.

OAuth Scope required: public.workflows.readWorkflows

get/workflows/{id}

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/workflows/{id}
  • 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.readWorkflows

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

Query parameters

hydrateEntitiesboolean

Indicates whether to fully hydrate related entities (true) or return minimal information (false).

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

idstring required
ironcladIdstring
titlestring required
templatestring required
stepstring required
isCancelledboolean required
isCompleteboolean required
status'active' | 'completed' | 'cancelled' | 'paused' required
createdstring required
lastUpdatedstring required
recordIdsstring[]
recordTypestring

The record type id this workflow resolves to. The same id is returned as type by the Records API, so workflows and records can be matched on record type. Should be present for all workflows launched via Workflow Designer.

recordTypeDisplayNamestring

The human-readable display label for the resolved record type (recordType). Optional; omitted when recordType is omitted.

isRevertibleToReviewboolean required

Example response

{
  "id": "6013609108b8f070cee94fc1",
  "ironcladId": "IC-1",
  "title": "Consulting Agreement with Jane Doe",
  "template": "600b296c3e15a234ab88f884",
  "step": "Review",
  "schema": {
    "counterpartyName": {
      "type": "string",
      "displayName": "Example String Attribute",
      "propertyKey": "counterpartyName",
      "readOnly": true
    },
    "amount": {
      "type": "number",
      "displayName": "Example Number Attribute",
      "propertyKey": "amount"
    },
    "fee": {
      "type": "monetaryAmount",
      "displayName": "Example Monetary Amount Attribute",
      "propertyKey": "fee"
    },
    "draft": {
      "type": "array",
      "elementType": {
        "type": "document",
        "displayName": "Example Document Attribute"
      }
    },
    "lineItems": {
      "type": "array",
      "elementType": {
        "type": "object",
        "displayName": "Example Object Attribute",
        "schema": {
          "childAttribute": {
            "type": "string",
            "displayName": "Example Value"
          },
          "anotherChildAttribute": {
            "displayName": "Example Value"
          },
          "numberAttribute": {
            "number": 5
          }
        }
      }
    }
  },
  "attributes": {
    "counterpartyName": "Boba Fett",
    "amount": 123,
    "fee": {
      "currency": "USD",
      "amount": 50000
    },
    "draft": [
      {
        "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"
      }
    ],
    "localLinkedRecord": {
      "recordId": "50cc0690-d3b5-4a0e-a9c0-4e323e409429",
      "readableId": "IC-123"
    },
    "localParentRecord": {
      "recordId": "50cc0690-d3b5-4a0e-a9c0-4e323e409430",
      "readableId": "IC-456"
    },
    "localChildRecord": {
      "recordId": "50cc0690-d3b5-4a0e-a9c0-4e323e409431",
      "readableId": "IC-789"
    }
  },
  "status": "active",
  "creator": {
    "id": "63d415e0dd0d828c3a878548",
    "displayName": "Boba Fett",
    "email": "fett@intergalactic.com",
    "title": "Director",
    "username": "fett@intergalactic.com",
    "metadata": {}
  },
  "created": "2016-11-17T00:37:22.318Z",
  "lastUpdated": "2016-11-17T00:37:22.318Z",
  "roles": [
    {
      "id": "legal",
      "displayName": "Legal",
      "assignees": [
        {
          "userName": "Boba Fett",
          "userId": "63d415e0dd0d828c3a878548",
          "email": "bobafett@example.com"
        }
      ]
    }
  ],
  "approvals": {
    "state": "not_started"
  },
  "signatures": {
    "state": "not_started"
  },
  "recordIds": [
    "715f1e37-292f-4e6c-8b48-c07e1b68bccd"
  ],
  "recordType": "consultingAgreement",
  "recordTypeDisplayName": "Consulting Agreement"
}

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