HeadOut · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Headout Partner API

4 actions 4 updates update extends openapi/headout-partner-openapi.yml
Derived by API Evangelist Built from the contracts HeadOut publishes. HeadOut did not publish this file.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-generatedx-apievangelist-sourcex-api-lifecyclex-conventionsx-error-catalogx-data-modelx-idempotencyx-idempotent

Targets 3

$.info
$.paths['/api/public/v1/booking'].post
$.paths['/api/public/v1/booking/{id}'].put

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Headout Partner API
  version: 1.0.0
extends: openapi/headout-partner-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-generated: '2026-07-19'
    x-apievangelist-source: https://github.com/headout/api-docs
    x-api-lifecycle: production
- target: $.info
  update:
    x-conventions: conventions/headout-conventions.yml
    x-error-catalog: errors/headout-error-codes.yml
    x-data-model: data-model/headout-data-model.yml
- target: $.paths['/api/public/v1/booking'].post
  update:
    x-idempotency: >-
      Two-step create-then-capture; capture (PUT /booking/{id} -> PENDING) is
      retry-safe. partnerReferenceId correlates to the partner order.
- target: $.paths['/api/public/v1/booking/{id}'].put
  update:
    x-idempotent: true

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/headout-partner-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.