Get Entity

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

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

{
  "label": "Employee",
  "viewPermission": [
    "HR",
    "MANAGER"
  ],
  "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",
      "isRequired": false,
    },
    {
      "id": "param-4",
      "name": "salary",
      "type": "CURRENCY",
      "isRequired": false,
    }
  ]
}

Create Simplified Entity Update Entity

Users

Roles

Database

Process

Measurements

Steps

Reports

Uploads

Policies

Legal Contracts

Policies

Organizations

Other

Overview

Example Request

Response Examples

​Overview

​Example Request

​Response Examples

Overview

Example Request

Response Examples