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

The Submissions API from Herald — 2 operation(s) for submissions.

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

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

This API exposes 2 operations across 2 paths, and defines 3 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.

2 operations 2 paths 3 schemas 1 GET1 POST

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 Submissions 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 2

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

Submissions 2
POST
/submissions
Submit an application to carriers
createSubmission body → 201401422
GET
/submissions/{submission_id}
Retrieve a submission
getSubmission 1 param → 200404

Schemas 3

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

SubmissionCreateRequest
object
2 properties 2 required
Submission
object
3 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

herald-submissions-api-openapi.yml Raw ↑

Other APIs Herald publishes across the network.

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