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

HeyForm Config API

Runtime configuration

HeyForm Config API is one of 7 APIs that HeyForm publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://api.heyform.net, http://localhost:8000.

1 operations 1 paths 1 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.heyform.net
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

HeyForm Config API declares 1 security scheme for authenticating requests. An API key is passed in the cookie as heyform_sid (cookieAuth).

  • cookieAuth — Session cookie set by the login mutation or OAuth callback. All authenticated GraphQL mutations and the CSV export endpoint require this cookie.

Paths & Operations 1

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

Config 1

Runtime configuration

GET
/api/config
Get runtime configuration
getConfig → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is RuntimeConfig (8 properties). Each schema is shown below with its type and property counts.

RuntimeConfig
object
Public runtime configuration returned by /api/config.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heyform-config-api-openapi.yml Raw ↑

Other APIs HeyForm publishes across the network.

HeyForm Auth API
HeyForm Forms API
HeyForm GraphQL API
HeyForm Images API
HeyForm Submissions API
HeyForm Upload API