Overview
When thesimplified=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"
}
]
}
{
"id": "step-456",
"label": "Document Review",
"description": "Review submitted contract documents",
"orderedPolicies": [
"review-policy-1",
"approval-policy-2"
],
"viewPolicyNames": [
"viewer-policy"
],
"webhookUrls": "https://example.com/webhook",
"stepIdsDependencies": [
"step-123"
],
"parameters": [
{
"id": "param-789",
"name": "contractDocument",
"type": "ATTACHMENT"
},
{
"id": "param-101",
"name": "approvalStatus",
"type": "SELECT"
}
]
}
{
"id": "step-456",
"label": "Document Review",
"description": "Review submitted contract documents",
"orderedPolicies": [
"review-policy-1",
"approval-policy-2"
],
"viewPolicyNames": [
"viewer-policy"
],
"webhookUrls": "https://example.com/webhook",
"stepIdsDependencies": [
"step-123"
],
"parameters": [
{
"id": "param-789",
"name": "contractDocument",
"type": "ENTITY_UPDATE",
"entityId": "entity-id-123",
"hideColumns": ["entity-parameter-id-1", "entity-parameter-id-2"],
"advancedOptions": {
"entityOperation": ["WRITE"]
}
},
{
"id": "param-101",
"name": "approvalStatus",
"type": "SELECT",
}
]
}
{
"id": "step-456",
"label": "Document Review",
"description": "Review submitted contract documents",
"orderedPolicies": [
"review-policy-1",
"approval-policy-2"
],
"viewPolicyNames": [
"viewer-policy"
],
"webhookUrls": "https://example.com/webhook",
"stepIdsDependencies": [
"step-123"
],
"parameters": [
{
"id": "param-789",
"name": "contractDocument",
"type": "ENTITY_UPDATE",
"entityId": "entity-id-123",
"advancedOptions": {
"entityOperation": ["WRITE"]
}
},
{
"id": "param-101",
"name": "approvalStatus",
"type": "SELECT",
}
]
}
{
"id": "step-456",
"label": "Document Review",
"description": "Review submitted contract documents",
"orderedPolicies": [
"review-policy-1",
"approval-policy-2"
],
"viewPolicyNames": [
"viewer-policy"
],
"webhookUrls": "https://example.com/webhook",
"stepIdsDependencies": [
"step-123"
],
"parameters": [
{
"id": "param-101",
"name": "approvalStatus",
"type": "SELECT",
"optionItems": [
{
"id": "id-123",
"value": "1",
"label": "Option 1"
},
{
"id": "id-123",
"value": "2",
"label": "Option 2"
}
]
}
]
}