How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Heron End User Entity API

The EndUserEntity API from Heron — 14 operation(s) for enduserentity.

Heron End User Entity API is one of 48 APIs that Heron publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include EndUserEntity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 18 operations across 14 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 2021-07-19.

Requests are made against a single base URL, https://app.herondata.io.

18 operations 14 paths 25 schemas 3 DELETE4 GET5 PATCH5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2021-07-19
Base URL
https://app.herondata.io/api
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Heron End User Entity API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 18

Across 14 paths, the API surfaces 18 operations — 3 DELETE, 4 GET, 5 PATCH, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

EndUserEntity 18
GET
/api/end_user_entities
Get the definitions for all end user entities
→ 200
POST
/api/end_user_entities
Create an end user entity
body → 200
GET
/api/end_user_entities/attribute_values/export
Export all saved attribute for all end users to an Excel file
→ 200404
PATCH
/api/end_user_entities/reorder
Set the display order of end user entities
body → 200
POST
/api/end_user_entities/{entity_heron_id}/attributes
Create an end user entity attribute
1 param body → 200
PATCH
/api/end_user_entities/{entity_heron_id}/attributes/reorder
Set the display order of end user entity attributes
1 param body → 200
DELETE
/api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}
Delete an EndUserEntityAttribute
2 params → 200404
PATCH
/api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}
Update an end user entity
2 params body → 200
POST
/api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}/clone
Create an end user entity attribute
2 params body → 200
POST
/api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}/sources
Create an end user entity attribute source
2 params body → 200
DELETE
/api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}/sources/{source_heron_id}
Delete an EndUserEntityAttribute
3 params → 200
PATCH
/api/end_user_entities/{entity_heron_id}/attributes/{attribute_heron_id}/sources/{source_heron_id}
Upsert an end user entity
3 params body → 200
DELETE
/api/end_user_entities/{heron_id}
Delete an EndUserEntity
1 param → 200
PATCH
/api/end_user_entities/{heron_id}
Update an end user entity
1 param body → 200
GET
/api/end_users/{end_user_heron_id}/entities
Get the materialised end user entities for an end user
1 param → 200
PUT
/api/end_users/{end_user_heron_id}/entities/values/bulk
Bulk save entity attribute values by entity name and attribute name
1 param body → 200404
POST
/api/end_users/{end_user_heron_id}/entities/{entity_heron_id}
Upsert the attribute value for an end user entity attribute source
2 params body → 200204
GET
/api/entities/post_processors
Get all available post processors
→ 200

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are NestedEndUserEntityAttribute (9 properties), NestedEndUserEntitySchema (8 properties), EndUserEntityAttributeSchema (8 properties), EndUserEntitySchema (7 properties). Each schema is shown below with its type and property counts.

EndUserEntityAttributeSource
object
4 properties
EndUserEntityAttributeSourceSchema
object
4 properties
UpdateEndUserEntityAttributeSourceSchema
object
3 properties
UpdateEndUserEntitySchema
object
6 properties
NestedEndUserEntityAttribute
object
9 properties
EndUserEntitySchema
object
7 properties
MaterialisedEndUserEntityAttribute
object
6 properties
UpdateEndUserEntityAttributeSchema
object
6 properties
PostProcessorConfigSchema
object
3 properties 1 required
BulkSaveEntityAttributeValueItem
object
3 properties 3 required
BulkSaveEntityAttributeValuesSchema
object
1 property 1 required
UpsertEndUserEntityAttributeValueSchema
object
3 properties 3 required
ReorderEndUserEntitiesSchema
object
1 property 1 required
BulkSaveEntityAttributeValueResultSchema
object
4 properties 3 required
CreateEndUserEntityAttributeSourceSchema
object
3 properties
CreateEndUserEntityAttributeSchema
object
7 properties 1 required
CloneEndUserEntityAttributeSchema
object
1 property 1 required
EndUserEntityAttributeValueSchema
object
2 properties
MaterialisedEndUserEntityAttributeSource
object
4 properties
NestedEndUserEntitySchema
object
8 properties
PostProcessorsResponseSchema
object
1 property 1 required
EndUserEntityAttributeSchema
object
8 properties
ReorderEndUserEntityAttributesSchema
object
1 property 1 required
CreateEndUserEntitySchema
object
6 properties 1 required
MaterialisedEndUserEntitySchema
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heron-enduserentity-api-openapi.yml Raw ↑

Other APIs Heron publishes across the network.

Heron Analytics API
Heron App Store API
Heron Authentication API
Heron Broker Funder Policies API
Heron Broker Submissions API
Heron Categories API
Heron Clear API
Heron Credentials API
Heron CRM Integrations API
Heron Email Templates API
Heron End Users API
Heron End User Accounts API
Where this information came from

This is an independent, third-party profile of Heron End User Entity API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.