Get OpenAPI JSON

GET

openapi.json

This OpenAPI document (JSON)

curl --request GET \
  --url https://billing.example.com/openapi.json \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://billing.example.com/openapi.json', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/openapi.json",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/openapi.json"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/openapi.json")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{}

Serves the same OpenAPI 3.1 document as Get OpenAPI YAML, converted from the embedded YAML to JSON once at process start. Use it with tooling that expects JSON — code generators, request validators, API gateways. The content is identical to the YAML form; only the encoding differs. No authentication is required. The conversion decodes the YAML into a generic map and re-encodes it with Go’s json.Marshal, so the body is a single compact line with object keys in alphabetical order (components, info, openapi, paths, security, servers, tags) rather than the authored order. Pipe it through jq . if you want to read it.

Example Request

curl https://api.recurso.dev/openapi.json -o recurso-openapi.json

Response

Content-Type: application/json. The body is the specification document itself — a bare OpenAPI object, not a data envelope. The excerpt below is pretty-printed and abridged (info.description, info.license, tags, every path but /health, the /health response content and 503, the portalSession and sessionCookie security schemes, and all of components.parameters, components.responses and components.schemas are omitted); the key order matches the real body, and every value shown is verbatim.

{
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "bearerFormat": "API key",
        "description": "Tenant API key obtained from `POST /auth/register` or `POST /v1/developer/keys`.",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "title": "Recurso API",
    "version": "1.0.0"
  },
  "openapi": "3.1.0",
  "paths": {
    "/health": {
      "get": {
        "description": "Reports overall service health plus per-component status (Postgres, Redis, TigerBeetle).",
        "operationId": "getHealth",
        "responses": {
          "200": { "description": "Service is healthy (or degraded but serving)." }
        },
        "security": [],
        "summary": "Health check",
        "tags": ["System"]
      }
    }
  },
  "security": [{ "bearerAuth": [] }],
  "servers": [
    {
      "description": "Example deployment — substitute the base URL of your own Recurso deployment.",
      "url": "https://billing.example.com"
    }
  ]
}

Errors

This endpoint has no failure modes of its own and always returns 200. The YAML-to-JSON conversion happens at boot and a conversion failure aborts startup, so a running instance never serves a malformed document.

Authorizations

Authorization

string

header

required

Response

200 - application/json

The OpenAPI 3.1 specification in JSON.

The response is of type object.

This OpenAPI document (JSON)

curl --request GET \
  --url https://billing.example.com/openapi.json \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://billing.example.com/openapi.json', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/openapi.json",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/openapi.json"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/openapi.json")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Example Request

Response

Errors

Authorizations

Response

​Example Request

​Response

​Errors

Authorizations

Response

Example Request

Response

Errors