Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.h3aven.com/llms.txt

Use this file to discover all available pages before exploring further.

​
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"
    }
  ]
}