Skip to main content
GET
/
v1
/
steps
/
{id}
curl --request GET \
  --url "https://h3-api-gateway.dev.h3aven.com/v1/steps/{id}?simplified=true" \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

{
  "id": "<string>",
  "label": "<string>",
  "description": "<string>",
  "prompt": "<string>",
  "processId": "<string>",
  "tokenIds": [
    "<string>"
  ],
  "policyNames": [
    "<string>"
  ],
  "roles": [
    {
      "p": "<string>",
      "r": [
        "<string>"
      ]
    }
  ],
  "orderedPolicies": [
    "<string>"
  ],
  "viewPolicyNames": [
    "<string>"
  ],
  "routing": {
    "entityParamName": "<string>",
    "entityId": "<string>",
    "rules": [
      {
        "value": "<string>",
        "stepId": "<string>"
      }
    ]
  },
  "webhookUrls": "<string>",
  "legalContractId": "<string>",
  "frequency": "<string>",
  "deadline": "<string>",
  "deadlineType": "<string>",
  "frequencyDate": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>",
  "counterpartsPoliciesRoles": [
    {
      "name": "<string>",
      "data": [
        {
          "permission": "<string>",
          "tokenId": "<string>",
          "role": "<string>"
        }
      ]
    }
  ],
  "stepIdsDependencies": [
    "<string>"
  ],
  "stepIdsReprovalDependencies": [
    "<string>"
  ],
  "hasSheetData": true,
  "parameters": [
    {
      "label": "<string>",
      "id": "<string>",
      "name": "<string>",
      "type": "ATTACHMENT",
      "isUnique": true,
      "isPermanent": true,
      "isRequired": true,
      "decimals": 123,
      "stepId": "<string>",
      "entityOperation": [
        "WRITE"
      ],
      "description": "<string>",
      "parameterId": "<string>",
      "entityId": "<string>",
      "autoFillEntityRelation": "<string>",
      "contractTemplateId": "<string>",
      "contractTemplate": {
        "templateEntityId": "<string>",
        "templateEntityName": "<string>"
      },
      "showColumns": [
        "<string>"
      ],
      "viewColumns": [
        "<string>"
      ],
      "computedFormula": [
        "<string>"
      ],
      "readFromOtherMeasurementData": {
        "processId": "<string>",
        "stepId": "<string>",
        "id": "<string>",
        "parameterId": "<string>",
        "readParameterId": "<string>",
        "searchFieldId": "<string>",
        "selectedFields": [
          {
            "readParameterId": "<string>",
            "writeParameterId": "<string>"
          }
        ]
      },
      "readFromEntity": {
        "stepId": "<string>",
        "id": "<string>",
        "processId": "<string>",
        "entityId": "<string>",
        "readParameterId": "<string>",
        "originParameterId": "<string>",
        "targetParameterIds": [
          "<string>"
        ],
        "createdAt": "<string>",
        "updatedAt": "<string>"
      },
      "optionItems": [
        {
          "value": "<string>",
          "id": "<string>",
          "label": "<string>",
          "color": "<string>",
          "meta": {},
          "parameterId": "<string>",
          "persisted": true,
          "entityParameterId": "<string>",
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "deletedAt": "<string>"
        }
      ],
      "apiCalls": [
        {
          "id": "<string>",
          "type": "<string>",
          "description": "<string>",
          "sort": [
            "<string>"
          ],
          "parameters": [
            "<unknown>"
          ],
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "sheetData": {
        "sheetApiId": "<string>",
        "id": "<string>",
        "cell": "<string>",
        "inputType": "<string>",
        "parameterId": "<string>",
        "entityId": "<string>",
        "entityParameterId": "<string>",
        "page": "<string>",
        "formula": "<string>"
      },
      "advancedOptions": {
        "id": "<string>",
        "tooltip": "<string>",
        "description": "<string>",
        "placeholder": "<string>",
        "max": 123,
        "maxLength": 123,
        "min": 123,
        "minLength": 123,
        "decimals": 123,
        "sort": 123,
        "currency": "USD",
        "locale": "pt-BR",
        "isHidden": true,
        "rightFreeze": true,
        "leftFreeze": true,
        "hasCustomColor": true,
        "hasMetadata": true,
        "hiddenFrom": [
          "<string>"
        ],
        "isMultiple": true,
        "insertOnEntity": "<string>",
        "insertOnEntityMetadata": [
          "<string>"
        ],
        "dateFormat": "dd/MM/yyyy",
        "entityOperation": [
          "WRITE"
        ],
        "parameterId": "<string>",
        "entityParameterId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "deletedAt": "<string>"
      },
      "parameters": [
        {
          "id": "<string>",
          "name": "<string>",
          "label": "<string>",
          "type": "ATTACHMENT",
          "isUnique": true,
          "isPermanent": true,
          "stepId": "<string>",
          "isRequired": true,
          "decimals": 123,
          "parameterId": "<string>",
          "computedFormula": [
            "<string>"
          ],
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "optionItems": [
            {
              "value": "<string>",
              "id": "<string>",
              "label": "<string>",
              "color": "<string>",
              "meta": {},
              "parameterId": "<string>",
              "persisted": true,
              "entityParameterId": "<string>",
              "createdAt": "<string>",
              "updatedAt": "<string>",
              "deletedAt": "<string>"
            }
          ],
          "sheetData": {
            "sheetApiId": "<string>",
            "id": "<string>",
            "cell": "<string>",
            "inputType": "<string>",
            "parameterId": "<string>",
            "entityId": "<string>",
            "entityParameterId": "<string>",
            "page": "<string>",
            "formula": "<string>"
          },
          "advancedOptions": {
            "id": "<string>",
            "tooltip": "<string>",
            "description": "<string>",
            "placeholder": "<string>",
            "max": 123,
            "maxLength": 123,
            "min": 123,
            "minLength": 123,
            "decimals": 123,
            "sort": 123,
            "currency": "USD",
            "locale": "pt-BR",
            "isHidden": true,
            "rightFreeze": true,
            "leftFreeze": true,
            "hasCustomColor": true,
            "hasMetadata": true,
            "hiddenFrom": [
              "<string>"
            ],
            "isMultiple": true,
            "insertOnEntity": "<string>",
            "insertOnEntityMetadata": [
              "<string>"
            ],
            "dateFormat": "dd/MM/yyyy",
            "entityOperation": [
              "WRITE"
            ],
            "parameterId": "<string>",
            "entityParameterId": "<string>",
            "createdAt": "<string>",
            "updatedAt": "<string>",
            "deletedAt": "<string>"
          },
          "autoFillEntityRelation": "<string>",
          "readFromOtherMeasurementData": {
            "processId": "<string>",
            "stepId": "<string>",
            "id": "<string>",
            "parameterId": "<string>",
            "readParameterId": "<string>",
            "searchFieldId": "<string>",
            "selectedFields": [
              {
                "readParameterId": "<string>",
                "writeParameterId": "<string>"
              }
            ]
          }
        }
      ],
      "entity": {
        "label": "<string>",
        "params": [
          {}
        ],
        "hasGSheetKey": true
      },
      "hasGSheetKey": true,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>"
    }
  ]
}

​
Overview

When the simplified=true query parameter is passed, the response returns a streamlined version of the step data with only essential fields. This reduces payload size and improves performance for use cases that don’t require full step details.

​
Example Request

curl --request GET \
  --url "https://h3-api-gateway.dev.h3aven.com/v1/steps/{id}?simplified=true" \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

​
Response Examples

The response structure depends on whether the step has configured policies and dependencies. Here are both variants: 
{
  "id": "step-456",
  "label": "Document Review",
  "parameters": [
    {
      "id": "param-789",
      "name": "contractDocument",
      "type": "ATTACHMENT"
    },
    {
      "id": "param-101",
      "name": "approvalStatus",
      "type": "SELECT"
    }
  ]
}

Path Parameters

​
id
string
required

Response

200 - application/json

ok

​
id
string
​
label
string
​
description
string
​
prompt
string
​
processId
string
​
tokenIds
string[]
​
policyNames
string[]
​
roles
object[]
​
orderedPolicies
string[]
​
viewPolicyNames
string[]
​
routing
object
​
webhookUrls
string
​
legalContractId
string
​
frequency
string
​
deadline
​
deadlineType
string
​
frequencyDate
​
createdAt
string
​
updatedAt
string
​
deletedAt
string
​
counterpartsPoliciesRoles
object[]
​
stepIdsDependencies
string[]
​
stepIdsReprovalDependencies
string[]
​
hasSheetData
boolean
​
parameters
object[]