Sign in

v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Workflows

Retrieve the Status of an Async Workflow Create Job

Check the status of a Workflow you created while using the Create a Workflow Async route.

OAuth Scope required: public.workflows.createWorkflows

get/workflows/async/{asyncJobId}

Path parameters

asyncJobIdstring required

The identifier provided in the response of creating a Workflow asynchronously.

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

The status of the workflow launch.

OR
OR

Example response

{
  "requestPayload": {
    "template": "600b296c3e15a234ab88f884",
    "attributes": {
      "counterpartyName": "Example Company",
      "draft": [
        {
          "url": "https://www.law.berkeley.edu/wp-content/uploads/2018/12/Resume-Samples-1.pdf"
        }
      ],
      "localLinkedRecord": "IC-123",
      "localParentRecord": "IC-456",
      "localChildRecord": "IC-789"
    },
    "creator": {
      "email": "example@example.com"
    }
  },
  "workflowUrls": {
    "browserUrl": "https://na1.ironcladapp.com/workflows/6013609108b8f070cee94fc1",
    "apiUrl": "https://na1.ironcladapp.com/public/api/v1/workflows/6013609108b8f070cee94fc1"
  },
  "workflow": {
    "id": "6013609108b8f070cee94fc1",
    "ironcladId": "IC-1",
    "title": "Consulting Agreement with Jane Doe",
    "template": "600b296c3e15a234ab88f884",
    "step": "Review",
    "schema": {
      "counterpartyName": "Example Company",
      "draft": [
        {
          "url": "https://www.law.berkeley.edu/wp-content/uploads/2018/12/Resume-Samples-1.pdf"
        }
      ],
      "localLinkedRecord": "IC-123",
      "localParentRecord": "IC-456",
      "localChildRecord": "IC-789"
    },
    "status": "active",
    "creator": {
      "id": "63d415e0dd0d828c3a878548",
      "email": "fett@intergalactic.com",
      "displayName": "Boba Fett"
    },
    "created": "2016-11-17T00:37:22.318Z",
    "lastUpdated": "2016-11-17T00:37:42.318Z",
    "roles": [
      {
        "id": "legal",
        "displayName": "Legal",
        "assignees": [
          {
            "userName": "Boba Fett",
            "userId": "63d415e0dd0d828c3a878548",
            "email": "bobafett@example.com"
          }
        ]
      }
    ],
    "approvals": {
      "state": "in_progress"
    },
    "signatures": {
      "state": "in_progress",
      "url": "https://na1.ironcladapp.com/public/api/v1/workflows/6dac47a10b1242d1f7df688d/signatures"
    },
    "recordIds": [
      "715f1e37-292f-4e6c-8b48-c07e1b68bccd"
    ]
  }
}