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

{
  "label": "<string>",
  "params": [
    {
      "label": "<string>",
      "id": "<string>",
      "name": "<string>",
      "type": "ATTACHMENT",
      "isUnique": true,
      "isRequired": true,
      "policyNames": [
        "<string>"
      ],
      "entityRelationAuxParamIds": [
        "<string>"
      ],
      "entityId": "<string>",
      "entityRelationId": "<string>",
      "entityRelation": {
        "id": "<string>",
        "name": "<string>"
      },
      "entityRelationParameter": {
        "id": "<string>",
        "label": "<string>",
        "type": "ATTACHMENT"
      },
      "entityRelationParameterId": "<string>",
      "computedFormula": [
        "<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>"
      },
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>"
    }
  ],
  "viewPermission": [
    "<string>"
  ],
  "dataProcessing": [
    {
      "id": "<string>",
      "type": "<string>",
      "inputParameters": [
        "<string>"
      ],
      "outputParameters": [
        "<string>"
      ]
    }
  ],
  "registerUserRoles": true,
  "legalContractId": "<string>",
  "validations": [
    {}
  ],
  "sheetData": {
    "sheetApiId": "<string>",
    "id": "<string>",
    "cell": "<string>",
    "inputType": "<string>",
    "parameterId": "<string>",
    "entityId": "<string>",
    "entityParameterId": "<string>",
    "page": "<string>",
    "formula": "<string>"
  }
}

​
Overview

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

​
Example Request

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

​
Response Examples

The response structure depends on whether the entity has configured view permissions. Here are both variants: 
{
  "label": "Employee",
  "params": [
    {
      "id": "param-1",
      "name": "firstName",
      "type": "TEXT",
      "isRequired": true
    },
    {
      "id": "param-2",
      "name": "lastName",
      "type": "TEXT",
      "isRequired": true
    },
    {
      "id": "param-3",
      "name": "email",
      "type": "EMAIL",
    }
  ]
}

Path Parameters

​
id
string
required

Query Parameters

​
parameterId
string
​
getRelations
string
​
simplified
string
​
includeIncomingRelations
string

Response

200 - application/json

ok

​
label
string
required
​
params
object[]
required
​
viewPermission
string[]
​
dataProcessing
object[]
​
registerUserRoles
boolean
​
legalContractId
string
​
validations
object[]
​
sheetData
object