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

The EndUserFiles API from Heron — 18 operation(s) for enduserfiles.

Heron End User Files 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 EndUserFiles. 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 22 operations across 18 paths, and defines 20 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.

22 operations 18 paths 20 schemas 1 DELETE10 GET3 PATCH8 POST

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 Files 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 22

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

EndUserFiles 22
GET
/api/end_user_files
All EndUserFiles
→ 200
POST
/api/end_user_files/process_standalone
Process file without creating EndUserFile record
body → 200
GET
/api/end_user_files/recent_by_file_class
Get recent files by file class
2 params → 200
GET
/api/end_user_files/rename_rules
Get file rename rules
→ 200
POST
/api/end_user_files/rename_rules
Create a file rename rule
body → 200
GET
/api/end_user_files/rename_rules/slugs
Get file rename rule variable slugs
→ 200
PATCH
/api/end_user_files/rename_rules/{heron_id}
Update a file rename rule
1 param body → 200
DELETE
/api/end_user_files/{heron_id}
Delete an EndUserFile
1 param → 200403404
GET
/api/end_user_files/{heron_id}
Get a single end user file by Heron ID
1 param → 200404
PATCH
/api/end_user_files/{heron_id}
Update the end user file's class
1 param body → 200
GET
/api/end_user_files/{heron_id}/file
Get EndUserFile as a base64 string
1 param → 200
POST
/api/end_user_files/{heron_id}/parse_file
Trigger async parsing of an end user file
1 param body → 200
GET
/api/end_user_files/{heron_id}/parsed_results
Get parsed results from uploaded files
3 params → 200
POST
/api/end_user_files/{heron_id}/trigger_rename
Trigger file's rename rule
1 param → 200
POST
/api/end_user_files/{heron_id}/trigger_split
Trigger splitting a combined end user file into its child files based on its pageclasses
1 param → 200
PATCH
/api/end_user_files/{parsed_end_user_file_id}/parsed_results
Update Parsed Results
1 param body → 200404
GET
/api/end_users/{end_user_id_or_heron_id}/files
Get EndUserFiles
1 param → 200
POST
/api/end_users/{end_user_id_or_heron_id}/filesdeprecated
Post EndUserFile
1 param body → 201
GET
/api/end_users/{end_user_id_or_heron_id}/files/download
Download EndUserFiles
1 param → 200
GET
/api/end_users/{end_user_id_or_heron_id}/files/parsed_results/xlsx
Download xlsx of parsed results from uploaded files
1 param → 200
POST
/api/end_users/{end_user_id_or_heron_id}/files/v2
Post EndUserFile V2
1 param body → 201
POST
/api/end_users/{end_user_id_or_heron_id}/start_workflow
Start Workflow
1 param → 200404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are EndUserEmailSchema (18 properties), EndUserFileSchema (15 properties), ParsedEndUserFile (14 properties), ParsedEndUserFileSchema (14 properties). Each schema is shown below with its type and property counts.

DataSourceNested
object
2 properties
CreateFileRenameRuleSchema
object
4 properties 3 required
EndUserFileSchema
object
15 properties
GetFileRenameRulesSchema
object
5 properties 3 required
ParsedEndUserFile
object
14 properties 4 required
EndUserFilePageClasses
object
2 properties
VariableDefinition
object
4 properties 4 required
EndUserFileUpdateSchema
object
4 properties
StandaloneProcessFileSchema
object
4 properties 3 required
PdfGet
object
3 properties
UpdateFileRenameRuleSchema
object
3 properties 2 required
EndUserFileUploadSchema
object
6 properties 2 required
GetIsoApplication
object
2 properties 2 required
EndUserFileBase64Schema
object
2 properties
ParseFileSchema
object
1 property
ParsedEndUserFilePatch
object
7 properties 2 required
EndUserEmailSchema
object
18 properties
ParsedEndUserFileSchema
object
14 properties 4 required
FieldValidation
object
4 properties 4 required
ParsedEndUserFileBoundingBox
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heron-enduserfiles-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 Files 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.