Endpoint

GET https://api.merion.com.au/openapi.yaml

Authentication: None required
Response type: application/yaml — OpenAPI 3.x specification
Purpose: The authoritative machine-readable description of all Merion API routes, request/response schemas, and authentication requirements.

Interactive documentation

The Scalar UI at https://api.merion.com.au/docs renders this spec interactively. Most developers will prefer to explore the API there before downloading the raw YAML. The Scalar UI lets you inspect request/response schemas, view example payloads, and try authenticated endpoints directly in the browser.

Downloading the spec

curl -O https://api.merion.com.au/openapi.yaml

This saves the file as openapi.yaml in your current directory.

Importing into API clients

Postman

Open Postman and click Import (top left).
Select Link.
Paste https://api.merion.com.au/openapi.yaml and click Continue.
Postman generates a collection with all documented endpoints and example request bodies.

Insomnia

Open Insomnia and go to Application → Import Data → From URL.
Paste https://api.merion.com.au/openapi.yaml.
Insomnia imports the spec and creates a request collection.

Bruno

Open Bruno and create or select a collection.
Use Import → OpenAPI Spec.
Paste the URL or provide the downloaded openapi.yaml file.

SDK generation

The spec is standard OpenAPI 3.x and is compatible with any conformant code generator. See SDK & Tools for full generation instructions. Example using openapi-generator-cli:

# Install the generator
npm install -g @openapitools/openapi-generator-cli

# Generate a TypeScript Fetch client
openapi-generator-cli generate \
  -i https://api.merion.com.au/openapi.yaml \
  -g typescript-fetch \
  -o ./merion-client

Other supported generators include python, java, go, php, and many more. See the openapi-generator documentation for the full list.

What the spec covers

The OpenAPI spec documents the publicly accessible endpoints including the public forms endpoint. Authenticated endpoints are described in the spec but require a Bearer token obtained via the OIDC flow — see Authentication for the full walkthrough. The spec is the authoritative reference for request and response schemas; this documentation site provides prose context and integration recipes.

Versioning

The spec does not currently carry a version field. The Merion API does not use URL version prefixes (e.g. /v1/). Breaking changes are communicated via the Changelog and via direct notification to registered integrators. Non-breaking additions — new optional fields, new endpoints — are made without a version bump.

OpenAPI Spec