---
title: "Retrieve a Workflow"
method: GET
path: "/workflows/{id}"
tags: ["Workflows"]
---

# Retrieve a Workflow

`GET /workflows/{id}`

View the data associated with a specific workflow. 

**OAuth Scope required:** `public.workflows.readWorkflows`

## Path parameters

- `id` string, required

## Query parameters

- `hydrateEntities` boolean

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Response `200`

200

- WorkflowResponseModel — The response from a successful workflow retrieval.
  - `id` string, required
  - `ironcladId` string
  - `title` string, required
  - `template` string, required
  - `step` string, required
  - `schema` object, required
    - `counterpartyName` object
      - `type` string
      - `displayName` string
      - `propertyKey` string — The unique identifier for the property.
      - `readOnly` boolean — Determines whether the property's value can be updated.
    - `amount` object
      - `type` string
      - `displayName` string
      - `propertyKey` string — The unique identifier for the property.
      - `readOnly` boolean — Determines whether the property's value can be updated.
    - `fee` object
      - `type` string
      - `displayName` string
      - `propertyKey` string — The unique identifier for the property.
      - `readOnly` boolean — Determines whether the property's value can be updated.
    - `draft` object
      - `type` string
      - `elementType` object
        - `type` string
        - `displayName` string
    - `lineItems` object
      - `type` string
      - `elementType` object
        - `type` string
        - `displayName` string
        - `schema` object
          - `childAttribute` object
            - `type` string
            - `displayName` string
          - `anotherChildAttribute` object
            - `type` 'string'
            - `displayName` string
          - `numberAttribute` object
            - `type` 'number'
            - `number` number
  - `attributes` object, required
    - `counterpartyName` string
    - `amount` integer
    - `fee` object
      - `currency` string
      - `amount` integer
    - `draft` WorkflowDocumentModel[]
      - `version` string, required — The version ID of the document's latest version
      - `versionNumber` number, required — The latest version number of the document
      - `filename` string, required — The name of the document with the extension
      - `key` string, required — The unique key associated with the document
      - `download` string, required — The URL to download the document omitting the base URL
      - `lastModified` object — The timestamp and author of the last modification to the document
        - `timestamp` string, required — The timestamp of the last modification to the document (ISO 8601 format)
        - `author` union — The author of an activity feed item
          - object — An internal author of an activity feed item
            - `type` 'internalUser', required — The type of author
            - `companyName` string, required — The company name of the author
            - `displayName` string — The display name of the author
            - `email` string — The email of the author
            - `userId` string — The user ID of the author
          - object — An external author of an activity feed item (typically a counterparty)
            - `type` 'externalUser', required — The type of author
            - `companyName` string, required — The company name of the author
            - `displayName` string — The display name of the author
            - `email` string — The email of the author
          - object — An integration author of an activity feed item
            - `type` 'integration', required — The type of author
            - `displayName` string, required — The display name of the integration
          - object — A system author of an activity feed item
            - `type` 'system', required — The type of author
            - `displayName` 'Ironclad', required — The display name of the system
    - `localLinkedRecord` LinkedRecordAttributeModel — A linked record attribute value. Contains the record ID and readable ID of the linked record.
      - `recordId` string — The UUID of the linked record
      - `readableId` string — The human-readable ID of the linked record
    - `localParentRecord` ParentRecordAttributeModel — A parent record attribute value. Contains the record ID and readable ID of the parent record.
      - `recordId` string — The UUID of the parent record
      - `readableId` string — The human-readable ID of the parent record
    - `localChildRecord` ChildRecordAttributeModel — A child record attribute value. Contains the record ID and readable ID of the child record.
      - `recordId` string — The UUID of the child record
      - `readableId` string — The human-readable ID of the child record
  - `isCancelled` boolean, required
  - `isComplete` boolean, required
  - `status` 'active' | 'completed' | 'cancelled' | 'paused', required
  - `creator` object
    - `id` string, required
    - `displayName` string, required
    - `email` string, required
    - `title` string, required
    - `username` string, required
    - `metadata` object, required
  - `created` string, required
  - `lastUpdated` string, required
  - `roles` object[], required
    - `id` string, required
    - `displayName` string, required
    - `assignees` object[], required
      - `userName` string, required
      - `userId` string, required
      - `email` string, required
  - `approvals` union, required
    - object
      - `state` 'not_started', required
    - object
      - `state` 'completed', required
    - object
      - `state` 'in_progress', required
      - `url` string, required
    - object
      - `state` 'not_applicable', required
      - `message` string, required
  - `signatures` union, required
    - object
      - `state` 'not_started', required
    - object
      - `state` 'completed', required
    - object
      - `state` 'in_progress', required
      - `url` string, required
    - object
      - `state` 'not_applicable', required
      - `message` string, required
  - `recordIds` string[]
  - `isRevertibleToReview` boolean, required

## Other responses

- `400` — 400

---

[API](https://skmtc.net/ironcladapp/apis/ironclad-public-api.md) · [All operations](https://skmtc.net/ironcladapp/apis/ironclad-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ironcladapp/ironclad-public-api/versions/9459b4cfc1e0/schema)