Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Online Ordering and SSO Deals API

4 actions 4 updates phrasing extends openapi/punchh-deals-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Punchh's API. It is a proposal applied on top of the contract, not a document Punchh publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/api/auth/deals'].get

$.paths['/api/auth/deals'].post

$.paths['/api/auth/deals/{redeemable_uuid}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Online Ordering and SSO Deals API
  version: 1.0.0
extends: openapi/punchh-deals-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/api/auth/deals'].get
  update:
    x-apievangelist-phrasing:
      intent: List deals available to a guest
      effect: read
      questions:
      - Which deals can a signed-in web guest choose from?
      - Can I show all available deals for a guest on the ordering site?
      instructions:
      - text: List all deals available to me.
      - text: Show available deals for token {auth_token}.
        slots:
          auth_token: requestBody.authentication_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/deals'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a deal to a guest's account
      effect: write
      questions:
      - How does a web guest add a deal to their account?
      - What identifies the deal when a guest saves it?
      instructions:
      - text: Save deal {redeemable_uuid} to my account.
        slots:
          redeemable_uuid: requestBody.redeemable_uuid
      - text: Add deal {redeemable_uuid} for the guest with token {auth_token}.
        slots:
          redeemable_uuid: requestBody.redeemable_uuid
          auth_token: requestBody.authentication_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/deals/{redeemable_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of a deal
      effect: read
      questions:
      - What does a particular deal include before a guest saves it?
      - Can I look up a single deal by its UUID?
      instructions:
      - text: Show the details of deal {redeemable_uuid}.
        slots:
          redeemable_uuid: path.redeemable_uuid
      - text: Describe what deal {redeemable_uuid} offers.
        slots:
          redeemable_uuid: path.redeemable_uuid
      method: generated
      generated: '2026-10-01'

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/punchh-deals-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

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