Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Herald Applications API

The Applications API from Herald — 2 operation(s) for applications.

Herald Applications API is one of 10 APIs that Herald publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Applications. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.heraldapi.com.

3 operations 2 paths 5 schemas 1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.heraldapi.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Herald Applications API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Send an API key or an access token from /auth/token in the Authorization header as Bearer . Access tokens are obtained via the OAuth2 client-credentials grant…

Paths & Operations 3

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

Applications 3
POST
/applications
Create an application
createApplication body → 201401422
GET
/applications/{application_id}
Retrieve an application
getApplication 1 param → 200404
PUT
/applications/{application_id}
Update an application
updateApplication 1 param body → 200404422

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Application (5 properties), Error (3 properties), ApplicationUpdateRequest (2 properties), ParameterValue (2 properties). Each schema is shown below with its type and property counts.

ParameterValue
object
2 properties
ApplicationCreateRequest
object
1 property 1 required
ApplicationUpdateRequest
object
2 properties
Application
object
5 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

herald-applications-api-openapi.yml Raw ↑

Other APIs Herald publishes across the network.

Herald Authentication API
Herald Classifications API
Herald Distributors API
Herald Files API
Herald Producers API
Herald Products API
Herald Quotes API
Herald Submissions API
Herald Webhooks API