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 Users API

The Users API from Heron — 4 operation(s) for users.

Heron Users 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 User. 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 5 operations across 4 paths, and defines 37 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.

5 operations 4 paths 37 schemas 2 GET3 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 Users 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 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 5
GET
/api/users/company_overview_layout
Get user's company overview layout
→ 200
PUT
/api/users/company_overview_layout
Save user's company overview layout
body → 204
GET
/api/users/current
Get the current user
→ 200
PUT
/api/users/current/settings
Save user's settings
body → 204
PUT
/api/users/{user_id}/workflow_owners
Update workflow owners for a user (admin only)
1 param body → 200404

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are FeatureSettings (65 properties), UserSettings (34 properties), User (17 properties), ModifiableSettings (13 properties). Each schema is shown below with its type and property counts.

HumanInTheLoopParserConfig
object
3 properties
AnnotatorSettings
object
4 properties
MetricFormulaSimpleMetricFilter
object
3 properties 2 required
InboundEmailSettings
object
5 properties
EndUserEntitiesSettings
object
1 property
QueryReportTabGroup
object
2 properties 2 required
BrokerVelocitySignal
object
3 properties
CompanyOverviewLayoutSchema
object
3 properties 3 required
FileSettings
object
12 properties
MetricFormulaMetric
object
3 properties 1 required
MetricSpec
object
7 properties 5 required
MetricFormula
object
9 properties 1 required
ModifiableSettings
object
13 properties
MetricFormulaScalar
object
1 property 1 required
Widget
object
4 properties 2 required
PnLCategories
object
5 properties
MetricFormulaSimpleMetric
object
5 properties 1 required
MetricFormulaAggregation
object
3 properties 2 required
MetricFormulaAdd
object
2 properties 2 required
AnnotationSettings
object
9 properties
RestrictedIndustry
object
2 properties
QueryReportTab
object
2 properties 2 required
FeatureSettings
object
65 properties
WidgetGroup
object
3 properties 3 required
BalanceSheetCategories
object
6 properties
MetricFormulaSub
object
2 properties 2 required
UserSettings
object
34 properties
MetricFormulaDiv
object
2 properties 2 required
User
object
17 properties 3 required
ScorecardSettings
object
2 properties
PdfSettings
object
13 properties
QueryReportWidget
object
3 properties 2 required
FlowmingoWorkflowOwners
object
2 properties
PlaidSettings
object
7 properties
OutboundEmailSettings
object
2 properties
UserModifiableSettings
object
13 properties
MetricFormulaMult
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heron-users-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 Users 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.