Punchh

Punchh, now part of PAR Technology and offered under the PAR Engagement brand, is an enterprise loyalty, offers, and customer engagement platform for restaurants. It unifies guest data from online ordering, mobile apps, POS, and kiosks into a single view so brands can run personalized loyalty and marketing programs. PAR exposes well-documented Punchh APIs through its developer portal covering platform functions, mobile, online ordering, POS and kiosk integration, and a webhooks manager, with sample collections published to Postman. Most integration surfaces require partner certification. Over 275 restaurant brands rely on Punchh to grow customer lifetime value.

Punchh publishes 46 API contracts indexed on the APIs.io network, including POS API, Api2 API, Auth API, and 43 more. Tagged areas include Gift Cards, Guest Engagement, Loyalty, Marketing, and Mobile.

The Punchh catalog on APIs.io includes 1 event-driven AsyncAPI specification, 4 JSON-LD contexts, and 2 Spectral governance rulesets.

Punchh’s developer surface includes authentication, documentation, developer portal, getting-started guide, engineering blog, sandbox, changelog, and 47 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

67.8/100 exemplar ▬ flat Agent 38/100 agent ready Front door AI 2/6 trace saas Full breakdown ↓
scored 2026-10-17 · rubric v0.24.0

AccessEnterprise

15 published contracts

Gift Cards Guest Engagement Loyalty Marketing Mobile Offers Online OrderingPAR TechnologyPoint-of-Sale Restaurant Restaurant Technology Webhook Loyalty & Incentives

What people ask Punchh 46

The questions people put to an LLM, and the jobs they hand an agent, that Punchh's APIs answer — each one linked to the operation that does it. Generated by API Evangelist

Punchh Users API Sign a guest in to the loyalty app “How do I log a guest into a restaurant's loyalty app with their email and password?” Register or log in a guest with Facebook “Can guests register on the loyalty app using their Facebook account?” Sign a guest in with Apple “Does the loyalty app support Sign in with Apple using Apple's private relay email?” Log a guest out of the mobile app “How do I end a guest's session in the mobile loyalty app?”

Punchh Api2 API Cancel an unprocessed redemption from the app “Can a guest cancel a redemption code in the mobile app before it has been used at the store?” Redeem banked currency for a redemption code “How can a guest turn part of their banked currency balance into a redemption code?” Redeem a completed visit card “In a visit-based loyalty program, how does a guest redeem a completed punch card from the app?” Redeem loyalty points for a redeemable “How does a guest spend loyalty points on a specific redeemable item from the catalog?”

Punchh Locations API Get a store location's configuration “What configuration does a store location expose to the app or POS?” Send POS diagnostic logs for a location “How do I report POS terminal diagnostics for a store to the loyalty platform?” Find nearby store locations “Which restaurant locations are closest to a guest's GPS position?” List a business's locations “How do I get all store locations and their details for a business?”

Punchh Auth API Redeem a reward against an online order receipt “How does an online ordering site apply a guest's reward or redemption code to a checkout under the older Redemptions 1.0 flow?” Generate a redemption code to use at the POS “How do I get a tracking code a guest can show at the register to redeem a reward?” Void a processed Redemptions 1.0 redemption “Can I reverse a redemption that has already been processed and give the offer back to the guest?” List rewards that apply to an online check “Which of the guest's rewards can be used on the items in this online order?”

Punchh POS API Check if a redemption can apply to a check “Can the POS verify a reward will work on a check before redeeming it?” Redeem a reward or discount on a receipt “How does the POS redeem a guest's reward against a receipt in Redemptions 1.0?” Void one processed redemption “How do I undo a single redemption and give the offer back to the guest?” Void several redemptions at once “Can the POS void multiple redemptions in one request?”

Punchh Gift Cards API Buy a new gift card in the app “How does a guest buy a brand-new gift card for themselves in the app?” Add funds to an existing gift card “Can a guest top up the balance on a gift card they already have?” Add a physical gift card to the app “How can a guest load a plastic gift card into their app wallet?” Rename a gift card or set auto-reload “Can a guest turn on auto-reload when their gift card balance gets low?”

Punchh Custom Segments API List all custom segments “What custom segments has my business created?” Create an empty custom segment “How do I create a new custom segment to hold a hand-picked list of guests?” Rename or redescribe a custom segment “Can I change the name or description of an existing custom segment?” Delete a custom segment “How do I permanently remove a custom segment we no longer use?”

Punchh Payments API Get a secure client token for a service “How does the app get a secure token for gift card or online ordering services?” Get a payment gateway client token “Where does the app get a client token to start a card payment?” Record an in-app payment “How does the app record a payment after the guest enters their card?” Get a PAR Pay card entry page for a token “How does a guest save a payment card to buy or reload gift cards?”

Punchh User Sign-up and SSO API Register a new guest account online “How does an online ordering site register a new loyalty guest with email and password?” Log a guest in with email and password “How do I sign an existing guest in with their email and password?” Exchange a security token for an auth token “How does a partner site turn its SSO security token into a guest authentication token?” Get a password reset token for a guest “How can a guest who forgot their password get a reset token?”

Punchh Point Of Sale API Get a store location's POS configuration “How does a POS terminal pull the loyalty settings for its own store location?” Get loyalty program details for the POS “What program type and redeemables does the register need to know about this loyalty program?” Enroll a new loyalty member at the register “Can a cashier sign a guest up for loyalty right at the POS with just a phone number?” Look up a loyalty guest and their balance at the POS “How does the register find a guest's loyalty account by phone, email or QR code?”

Punchh User Management API Send a guest a password reset email “How does a guest on the web ordering site reset a forgotten password?” Get a signed-in guest's profile details “Can I read a guest's birthday, anniversary and zip code after SSO login?” Update a guest's profile or password “Can a guest change their name or anniversary from the website?” Get a guest's account history “Where can a web guest see their check-ins and other loyalty events?”

Punchh Check Ins API Earn points by scanning a receipt barcode “How does a guest get points by scanning the barcode on their receipt?” Earn points by scanning a QR code “Can guests earn loyalty points by scanning a QR code in the app?” Earn points by uploading a receipt photo “Can a guest snap a photo of a receipt to get loyalty credit?” List a guest's check-ins “Where can a guest see all of their past check-ins?”

Showing 12 of 46 APIs with phrasing — see every API.

Kin Score

Kin Score How this is scored →
scored 2026-10-17 · rubric v0.24.0

Composite quality — 67.8/100 · exemplar

Contract Quality 12.0 / 19

Developer Ergonomics 10.3 / 15

Access Clarity 6.3 / 15

Operational Transparency 9.0 / 10

Contract Governance 4.1 / 9

Discoverability 5.9 / 8

Regulatory Posture 4.2 / 15

Create-or-Update Ergonomics 3.9 / 10

Agent readiness — 38/100 · agent ready

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 6 / 6

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 9 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 6 / 6

Agent Skills 5 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 0 / 6

Protected Resource Metadata 0 / 5

Registration Without a Human 0 / 6

Agentic Commerce Well-Known Document 0 / 5

Regulatory Posture applies to this provider. Its tags matched the Payments regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from github.com/api-evangelist/punchh: open an issue to ask a question, or submit a pull request to add artifacts. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Restaurants and POS	builds-on	52.5	-	-

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

APIs 46

Individual APIs this provider publishes, each with its own machine-readable definition.

Punchh POS API

Punchh provides robust APIs for integrating POS (Point-of-Sale) terminals with its back end. The integration helps businesses to offer their customers loyalty programs directly ...

Punchh Api2 API

The Api2 API from Punchh — 26 operation(s) for api2.

Punchh Auth API

The Auth API from Punchh — 14 operation(s) for auth.

Punchh Badges API

The Badges API from Punchh — 1 operation(s) for badges.

Punchh Beacons API

The Beacons API from Punchh — 2 operation(s) for beacons.

Punchh Business Admin Users API

The Business Admin Users API from Punchh — 3 operation(s) for business admin users.

Punchh Business Migration Users API

The Business Migration Users API from Punchh — 3 operation(s) for business migration users.

Punchh Challenges API

The Challenges API from Punchh — 5 operation(s) for challenges.

Punchh Check In API

The Check-in API from Punchh — 3 operation(s) for check-in.

Punchh Check Ins API

The Check-ins API from Punchh — 6 operation(s) for check-ins.

Punchh Check User Balance API

The Check User Balance API from Punchh — 4 operation(s) for check user balance.

Punchh Collectibles API

The Collectibles API from Punchh — 3 operation(s) for collectibles.

Punchh Coupons API

The Coupons API from Punchh — 1 operation(s) for coupons.

Punchh Custom Segments API

The Custom Segments API from Punchh — 5 operation(s) for custom segments.

Punchh Deals API

The Deals API from Punchh — 2 operation(s) for deals.

Punchh Drive Thru API

The Drive-Thru API from Punchh — 1 operation(s) for drive-thru.

Punchh E Club API

The eClub API from Punchh — 1 operation(s) for eclub.

Punchh Feedback API

The Feedback API from Punchh — 4 operation(s) for feedback.

Punchh File Upload API

The File Upload API from Punchh — 1 operation(s) for file upload.

Punchh Franchisee API

The Franchisee API from Punchh — 1 operation(s) for franchisee.

Punchh Game API

The Game API from Punchh — 1 operation(s) for game.

Punchh Gift Cards API

The Gift Cards API from Punchh — 14 operation(s) for gift cards.

Punchh Invitations API

The Invitations API from Punchh — 4 operation(s) for invitations.

Punchh Locations API

The Locations API from Punchh — 9 operation(s) for locations.

Punchh Loyalty Transfers API

The Loyalty Transfers API from Punchh — 3 operation(s) for loyalty transfers.

Punchh Meta API

The Meta API from Punchh — 1 operation(s) for meta.

Punchh Meta & Version API

The Meta & Version API from Punchh — 3 operation(s) for meta & version.

Punchh Migration API

The Migration API from Punchh — 2 operation(s) for migration.

Punchh Notifications API

The Notifications API from Punchh — 5 operation(s) for notifications.

Punchh Offers API

The Offers API from Punchh — 2 operation(s) for offers.

Punchh Passcodes API

The Passcodes API from Punchh — 2 operation(s) for passcodes.

Punchh Payment Cards API

The Payment Cards API from Punchh — 2 operation(s) for payment cards.

Punchh Payments API

The Payments API from Punchh — 7 operation(s) for payments.

Punchh Point Of Sale API

The Point Of Sale API from Punchh — 8 operation(s) for point of sale.

Punchh Redemptions API

The Redemptions API from Punchh — 2 operation(s) for redemptions.

Punchh Referrals API

The Referrals API from Punchh — 1 operation(s) for referrals.

Punchh Rewards API

The Rewards API from Punchh — 5 operation(s) for rewards.

Punchh Single Scan Code API

The Single Scan Code API from Punchh — 1 operation(s) for single scan code.

Punchh Social Cause Campaign API

The Social Cause Campaign API from Punchh — 2 operation(s) for social cause campaign.

Punchh Social Cause Campaigns API

The Social Cause Campaigns API from Punchh — 3 operation(s) for social cause campaigns.

Punchh Surveys API

The Surveys API from Punchh — 1 operation(s) for surveys.

Punchh Swag API

The Swag API from Punchh — 4 operation(s) for swag.

Punchh User Management API

The User Management API from Punchh — 5 operation(s) for user management.

Punchh User Sign-up and SSO API

The User Sign-up and SSO API from Punchh — 8 operation(s) for user sign-up and sso.

Punchh Users API

The Users API from Punchh — 35 operation(s) for users.

Punchh WiFi Acquisition API

The WiFi Acquisition API from Punchh — 2 operation(s) for wifi acquisition.

Scroll for all 46

Postman Collections 7

Ready-to-run Postman collections for exercising this provider's APIs.

PAR Punchh Mobile Check-In API

POSTMAN

PAR Punchh Mobile Check-In Check-Ins API

POSTMAN

PAR Punchh Mobile Check-In Configuration API

POSTMAN

PAR Punchh Mobile Check-In Offers API

POSTMAN

PAR Punchh Mobile Check-In Receipts API

POSTMAN

PAR Punchh Mobile Check-In Redemptions API

POSTMAN

PAR Punchh Mobile Check-In Users API

POSTMAN

Scroll for all 7

Open Collections 20

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

API Collection

OPEN COLLECTION

Mobile API

OPEN COLLECTION

Redemptions 1.0 (Legacy) API - Mobile

OPEN COLLECTION

Redemptions 2.0 (New) API - Mobile

OPEN COLLECTION

Subscription API - Mobile

OPEN COLLECTION

PAR Punchh Mobile API

OPEN COLLECTION

Redemptions 1.0 (Legacy) API - Online Ordering

OPEN COLLECTION

Redemptions 2.0 (New) API - Online Ordering

OPEN COLLECTION

Online Ordering and SSO API

OPEN COLLECTION

Subscription API - Online Ordering

OPEN COLLECTION

PAR Punchh Online Ordering and SSO API

OPEN COLLECTION

Platform Functions API

OPEN COLLECTION

Headless Offers API - Platform Functions

OPEN COLLECTION

Offers Ingestion API - Platform Functions

OPEN COLLECTION

Subscription API - Platform Functions

OPEN COLLECTION

PAR Punchh Platform Functions API

OPEN COLLECTION

POS API

OPEN COLLECTION

Redemptions 1.0 (Legacy) API - POS

OPEN COLLECTION

Redemptions 2.0 (New) API - POS

OPEN COLLECTION

PAR Punchh POS and Kiosk API

OPEN COLLECTION

Scroll for all 20

Pricing Plans 1

Published pricing tiers and plan structures.

Punchh Plans Pricing

1 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Punchh Rate Limits

4 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Punchh Finops

FINOPS

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Punchh Webhooks

ASYNCAPI

Semantic Vocabularies 4

JSON-LD contexts and semantic vocabularies used across these APIs.

Punchh Mobile Context

8 classes · 52 properties

JSON-LD

Punchh Online Ordering Context

4 classes · 27 properties

JSON-LD

Punchh Platform Functions Context

1 classes · 5 properties

JSON-LD

Punchh Pos Context

2 classes · 10 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

Punchh — jsonschema rules

5 rules · 4 warnings 1 info

SPECTRAL

Punchh API Rules

37 rules · 3 errors 23 warnings 11 info

SPECTRAL

OpenAPI Overlays 61

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Punchh Api2 Api Phrasing Overlay

34 actions · phrasing · punchh-api2-api-openapi.yml

GENERATED

Punchh Auth Api Phrasing Overlay

17 actions · phrasing · punchh-auth-api-openapi.yml

GENERATED

Punchh Badges Api Phrasing Overlay

2 actions · phrasing · punchh-badges-api-openapi.yml

GENERATED

Punchh Beacons Api Phrasing Overlay

3 actions · phrasing · punchh-beacons-api-openapi.yml

GENERATED

Punchh Business Admin Users Api Phrasing Overlay

7 actions · phrasing · punchh-business-admin-users-api-openapi.yml

GENERATED

Punchh Business Migration Users Api Phrasing Overlay

5 actions · phrasing · punchh-business-migration-users-api-openapi.yml

GENERATED

Punchh Challenges Api Phrasing Overlay

6 actions · phrasing · punchh-challenges-api-openapi.yml

GENERATED

Punchh Check In Api Phrasing Overlay

7 actions · phrasing · punchh-check-in-api-openapi.yml

GENERATED

Punchh Check Ins Api Phrasing Overlay

7 actions · phrasing · punchh-check-ins-api-openapi.yml

GENERATED

Punchh Check User Balance Api Phrasing Overlay

5 actions · phrasing · punchh-check-user-balance-api-openapi.yml

GENERATED

Punchh Collectibles Api Phrasing Overlay

4 actions · phrasing · punchh-collectibles-api-openapi.yml

GENERATED

Punchh Coupons Api Phrasing Overlay

2 actions · phrasing · punchh-coupons-api-openapi.yml

GENERATED

Punchh Custom Segments Api Phrasing Overlay

11 actions · phrasing · punchh-custom-segments-api-openapi.yml

GENERATED

Punchh Deals Api Phrasing Overlay

4 actions · phrasing · punchh-deals-api-openapi.yml

GENERATED

Punchh Drive Thru Api Phrasing Overlay

2 actions · phrasing · punchh-drive-thru-api-openapi.yml

GENERATED

Punchh Eclub Api Phrasing Overlay

2 actions · phrasing · punchh-eclub-api-openapi.yml

GENERATED

Punchh Feedback Api Phrasing Overlay

5 actions · phrasing · punchh-feedback-api-openapi.yml

GENERATED

Punchh File Upload Api Phrasing Overlay

2 actions · phrasing · punchh-file-upload-api-openapi.yml

GENERATED

Punchh Franchisee Api Phrasing Overlay

4 actions · phrasing · punchh-franchisee-api-openapi.yml

GENERATED

Punchh Game Api Phrasing Overlay

2 actions · phrasing · punchh-game-api-openapi.yml

GENERATED

Punchh Gift Cards Api Phrasing Overlay

16 actions · phrasing · punchh-gift-cards-api-openapi.yml

GENERATED

Punchh Invitations Api Phrasing Overlay

6 actions · phrasing · punchh-invitations-api-openapi.yml

GENERATED

Punchh Locations Api Phrasing Overlay

17 actions · phrasing · punchh-locations-api-openapi.yml

GENERATED

Punchh Loyalty Transfers Api Phrasing Overlay

4 actions · phrasing · punchh-loyalty-transfers-api-openapi.yml

GENERATED

Punchh Meta Api Phrasing Overlay

2 actions · phrasing · punchh-meta-api-openapi.yml

GENERATED

Punchh Meta Version Api Phrasing Overlay

4 actions · phrasing · punchh-meta-version-api-openapi.yml

GENERATED

Punchh Migration Api Phrasing Overlay

5 actions · phrasing · punchh-migration-api-openapi.yml

GENERATED

Punchh Mobile Api Overlay

3 actions · documentation · punchh-mobile-api-openapi.yml

GENERATED

Punchh Mobile Redemptions Legacy Overlay

3 actions · documentation · punchh-mobile-redemptions-legacy-openapi.yml

GENERATED

Punchh Mobile Redemptions V2 Overlay

3 actions · documentation · punchh-mobile-redemptions-v2-openapi.yml

GENERATED

Punchh Mobile Subscription Overlay

3 actions · documentation · punchh-mobile-subscription-openapi.yml

GENERATED

Punchh Notifications Api Phrasing Overlay

6 actions · phrasing · punchh-notifications-api-openapi.yml

GENERATED

Punchh Offers Api Phrasing Overlay

3 actions · phrasing · punchh-offers-api-openapi.yml

GENERATED

Punchh Online Ordering Redemptions Legacy Overlay

3 actions · documentation · punchh-online-ordering-redemptions-legacy-openapi.yml

GENERATED

Punchh Online Ordering Redemptions V2 Overlay

3 actions · documentation · punchh-online-ordering-redemptions-v2-openapi.yml

GENERATED

Punchh Online Ordering Sso Api Overlay

3 actions · documentation · punchh-online-ordering-sso-api-openapi.yml

GENERATED

Punchh Online Ordering Subscription Overlay

3 actions · documentation · punchh-online-ordering-subscription-openapi.yml

GENERATED

Punchh Passcodes Api Phrasing Overlay

3 actions · phrasing · punchh-passcodes-api-openapi.yml

GENERATED

Punchh Payment Cards Api Phrasing Overlay

5 actions · phrasing · punchh-payment-cards-api-openapi.yml

GENERATED

Punchh Payments Api Phrasing Overlay

10 actions · phrasing · punchh-payments-api-openapi.yml

GENERATED

Punchh Platform Functions Api Overlay

3 actions · documentation · punchh-platform-functions-api-openapi.yml

GENERATED

Punchh Platform Functions Headless Offers Overlay

3 actions · documentation · punchh-platform-functions-headless-offers-openapi.yml

GENERATED

Punchh Platform Functions Offers Ingestion Overlay

3 actions · documentation · punchh-platform-functions-offers-ingestion-openapi.yml

GENERATED

Punchh Platform Functions Subscription Overlay

3 actions · documentation · punchh-platform-functions-subscription-openapi.yml

GENERATED

Punchh Point Of Sale Api Phrasing Overlay

9 actions · phrasing · punchh-point-of-sale-api-openapi.yml

GENERATED

Punchh Pos Api Overlay

3 actions · documentation · punchh-pos-api-openapi.yml

GENERATED

Punchh Pos Api Phrasing Overlay

16 actions · phrasing · punchh-pos-api-openapi.yml

GENERATED

Punchh Pos Redemptions Legacy Overlay

3 actions · documentation · punchh-pos-redemptions-legacy-openapi.yml

GENERATED

Punchh Pos Redemptions V2 Overlay

3 actions · documentation · punchh-pos-redemptions-v2-openapi.yml

GENERATED

Punchh Redemptions Api Phrasing Overlay

4 actions · phrasing · punchh-redemptions-api-openapi.yml

GENERATED

Punchh Referrals Api Phrasing Overlay

3 actions · phrasing · punchh-referrals-api-openapi.yml

GENERATED

Punchh Rewards Api Phrasing Overlay

6 actions · phrasing · punchh-rewards-api-openapi.yml

GENERATED

Punchh Single Scan Code Api Phrasing Overlay

2 actions · phrasing · punchh-single-scan-code-api-openapi.yml

GENERATED

Punchh Social Cause Campaign Api Phrasing Overlay

4 actions · phrasing · punchh-social-cause-campaign-api-openapi.yml

GENERATED

Punchh Social Cause Campaigns Api Phrasing Overlay

4 actions · phrasing · punchh-social-cause-campaigns-api-openapi.yml

GENERATED

Punchh Surveys Api Phrasing Overlay

2 actions · phrasing · punchh-surveys-api-openapi.yml

GENERATED

Punchh Swag Api Phrasing Overlay

6 actions · phrasing · punchh-swag-api-openapi.yml

GENERATED

Punchh User Management Api Phrasing Overlay

8 actions · phrasing · punchh-user-management-api-openapi.yml

GENERATED

Punchh User Sign Up And Sso Api Phrasing Overlay

9 actions · phrasing · punchh-user-sign-up-and-sso-api-openapi.yml

GENERATED

Punchh Users Api Phrasing Overlay

44 actions · phrasing · punchh-users-api-openapi.yml

GENERATED

Punchh Wifi Acquisition Api Phrasing Overlay

5 actions · phrasing · punchh-wifi-acquisition-api-openapi.yml

GENERATED

Scroll for all 61

JSON Schema 15

Standalone JSON Schema definitions for this provider's data models.

AccessToken

4 properties

JSON SCHEMA

CreateUserRequest

4 properties

JSON SCHEMA

LoginRequest

2 properties

JSON SCHEMA

MarkOffersReadRequest

4 properties

JSON SCHEMA

TransactionDetailsRequest

2 properties

JSON SCHEMA

TransactionDetails

2 properties

JSON SCHEMA

UpdateUserProfileRequest

2 properties

JSON SCHEMA

UserSession

2 properties

JSON SCHEMA

OnlineOrderCheckinRequest

12 properties

JSON SCHEMA

OnlineOrderCheckinResponse

5 properties

JSON SCHEMA

OnlineOrderRedemptionRequest

7 properties

JSON SCHEMA

OnlineOrderRedemptionResponse

7 properties

JSON SCHEMA

Redeemable

5 properties

JSON SCHEMA

PosCheckinRequest

4 properties

JSON SCHEMA

PosUser

6 properties

JSON SCHEMA

Scroll for all 15

JSON Structure 15

JSON Structure definitions describing this provider's data shapes.

Mobile Access Token Structure

4 properties

JSON STRUCTURE

Mobile Create User Request Structure

4 properties

JSON STRUCTURE

Mobile Login Request Structure

2 properties

JSON STRUCTURE

Mobile Mark Offers Read Request Structure

4 properties

JSON STRUCTURE

Mobile Transaction Details Request Structure

2 properties

JSON STRUCTURE

Mobile Transaction Details Structure

2 properties

JSON STRUCTURE

Mobile Update User Profile Request Structure

2 properties

JSON STRUCTURE

Mobile User Session Structure

2 properties

JSON STRUCTURE

Online Ordering Online Order Checkin Request Structure

12 properties

JSON STRUCTURE

Online Ordering Online Order Checkin Response Structure

5 properties

JSON STRUCTURE

Online Ordering Online Order Redemption Request Structure

7 properties

JSON STRUCTURE

Online Ordering Online Order Redemption Response Structure

7 properties

JSON STRUCTURE

Platform Functions Redeemable Structure

5 properties

JSON STRUCTURE

Pos Pos Checkin Request Structure

4 properties

JSON STRUCTURE

Pos Pos User Structure

6 properties

JSON STRUCTURE

Scroll for all 15

Examples 15

Example request and response payloads for these APIs.

Mobile Access Token Example

4 fields

EXAMPLE

Mobile Create User Request Example

4 fields

EXAMPLE

Mobile Login Request Example

2 fields

EXAMPLE

Mobile Mark Offers Read Request Example

4 fields

EXAMPLE

Mobile Transaction Details Example

2 fields

EXAMPLE

Mobile Transaction Details Request Example

2 fields

EXAMPLE

Mobile Update User Profile Request Example

2 fields

EXAMPLE

Mobile User Session Example

2 fields

EXAMPLE

Online Ordering Online Order Checkin Request Example

12 fields

EXAMPLE

Online Ordering Online Order Checkin Response Example

5 fields

EXAMPLE

Online Ordering Online Order Redemption Request Example

7 fields

EXAMPLE

Online Ordering Online Order Redemption Response Example

7 fields

EXAMPLE

Platform Functions Redeemable Example

5 fields

EXAMPLE

Pos Pos Checkin Request Example

4 fields

EXAMPLE

Pos Pos User Example

6 fields

EXAMPLE

Scroll for all 15

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Punchh Authentication

http/apiKey/oauth2-flavoured · 7 schemes

SECURITY

Punchh Domain Security

TLSv1.3 · DMARC

SECURITY

Punchh Vulnerability Disclosure

Hackerone

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Punchh Agentic Access

288 operations · 191 acting · 3 human-in-the-loop

288 operations · 191 acting

AGENTIC

Resources

Get Started 3

Portal, sign-up, and the first successful call

Portal

Portal

GettingStarted

GettingStarted

Sandbox

Sandbox

Documentation 2

Reference material describing how the API behaves

Documentation

Documentation

APIReference

APIReference

Agent Surfaces 4

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

LLMsTxt

LLMsTxt

X-MCPServerCandidate

X-MCPServerCandidate

AgentSkill

AgentSkill

Design & Contract 10

Pagination, idempotency, versioning, errors, and events

SpectralRules

Vocabulary

Webhooks

Conventions

Idempotency

ErrorCatalog

Lifecycle

Conformance

DataModel

Webhooks

Scroll for all 10

Build 4

SDKs, sample code, and the tooling you integrate with

PostmanWorkspace

PostmanWorkspace

GitHubOrganization

GitHubOrganization

Packages

Packages

Postman

Postman

Access & Security 5

Authentication, authorization, and security posture

VulnerabilityDisclosure

VulnerabilityDisclosure

DomainSecurity

Authentication

Security

SecurityPolicy

Operate 5

Status, limits, changes, and where to get help

RateLimits

StatusPage

Deprecation

ChangeLog

Support

Commercial 4

Pricing, plans, and the legal terms of use

Plans

FinOps

PrivacyPolicy

TermsOfService

Company 3

The organization behind the API

Website

Website

Blog

Blog

LinkedIn

Other 14

Properties that don't map to a standard resource type

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Overlay

Scroll for all 14

Source (apis.yml)

aid: punchh
name: Punchh
description: Punchh, now part of PAR Technology and offered under the PAR Engagement brand, is an enterprise loyalty, offers,
  and customer engagement platform for restaurants. It unifies guest data from online ordering, mobile apps, POS, and kiosks
  into a single view so brands can run personalized loyalty and marketing programs. PAR exposes well-documented Punchh APIs
  through its developer portal covering platform functions, mobile, online ordering, POS and kiosk integration, and a webhooks
  manager, with sample collections published to Postman. Most integration surfaces require partner certification. Over 275
  restaurant brands rely on Punchh to grow customer lifetime value.
type: Index
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: enterprise
  onboarding: partner-certification
  trial: false
  try_now: false
  public: false
  label: Enterprise · Partner certification required
  confidence: high
  source:
  - https://developers.partech.com/engagement-tools/par-punchh/
  - plans
  - authentication
  generated: '2026-08-13'
  method: searched
  note: 'Every Punchh API section on the PAR developer portal is badged "Certification REQUIRED". Documentation and the 15
    OpenAPI documents are fully public and anonymous; credentials, base URIs and sandbox access are issued by a PAR representative
    after certification. Corrected from onboarding: self-serve, which was wrong.'
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/punchh.png
x-docs-platform: scalar
x-docs-platform-confidence: high
x-docs-platform-checked: 2026-10-04
tags:
- Gift Cards
- Guest Engagement
- Loyalty
- Marketing
- Mobile
- Offers
- Online Ordering
- PAR Technology
- Point-of-Sale
- Restaurant
- Restaurant Technology
- Webhook
- Loyalty & Incentives
tags_raw:
- Gift Cards
- Guest Engagement
- Loyalty
- Marketing
- Mobile
- Offers
- Online Ordering
- PAR Technology
- Point Of Sale
- Restaurant
- Restaurant Technology
- Webhooks
- Loyalty & Incentives
url: https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/apis.yml
created: '2026-06-02'
modified: '2026-08-13'
specificationVersion: '0.23'
apis:
- aid: punchh:punchh-pos-api
  name: Punchh POS API
  description: Punchh provides robust APIs for integrating POS (Point-of-Sale) terminals with its back end. The integration
    helps businesses to offer their customers loyalty programs directly from their POS systems. Published by PAR on the pos
    section of the PAR developer portal; 13 operations. Certification required.
  humanURL: https://developers.partech.com/docs/dev-portal-pos
  baseURL: https://{server_name}.punchh.com
  tags:
  - Payments
  - Point-of-Sale
  tags_raw:
  - Payments
  - Point Of Sale
  properties:
  - type: OpenAPI
    url: openapi/punchh-pos-api-openapi.yml
  - type: Overlay
    url: overlays/punchh-pos-api-overlay.yaml
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-pos
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-pos
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-pos/make-your-first-pos-api-call
  - type: JSONSchema
    url: json-schema/pos-pos-checkin-request-schema.json
  - type: JSONSchema
    url: json-schema/pos-pos-user-schema.json
  - type: JSONStructure
    url: json-structure/pos-pos-checkin-request-structure.json
  - type: JSONStructure
    url: json-structure/pos-pos-user-structure.json
  - type: Examples
    url: examples/pos-pos-checkin-request-example.json
  - type: Examples
    url: examples/pos-pos-user-example.json
  - type: JSONLD
    url: json-ld/punchh-pos-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-pos.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-pos.opencollection.json
- aid: punchh:punchh-api2-api
  name: Punchh Api2 API
  description: The Api2 API from Punchh — 26 operation(s) for api2.
  humanURL: https://developers.partech.com/docs/dev-portal-mobile
  baseURL: https://{server_name}.punchh.com
  tags:
  - Api2
  properties:
  - type: OpenAPI
    url: openapi/punchh-api2-api-openapi.yml
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-mobile
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-mobile
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-mobile/make-your-first-mobile-api-call
  - type: JSONSchema
    url: json-schema/mobile-access-token-schema.json
  - type: JSONSchema
    url: json-schema/mobile-create-user-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-login-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-mark-offers-read-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-transaction-details-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-transaction-details-schema.json
  - type: JSONSchema
    url: json-schema/mobile-update-user-profile-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-user-session-schema.json
  - type: JSONStructure
    url: json-structure/mobile-access-token-structure.json
  - type: JSONStructure
    url: json-structure/mobile-create-user-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-login-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-mark-offers-read-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-transaction-details-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-transaction-details-structure.json
  - type: JSONStructure
    url: json-structure/mobile-update-user-profile-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-user-session-structure.json
  - type: Examples
    url: examples/mobile-access-token-example.json
  - type: Examples
    url: examples/mobile-create-user-request-example.json
  - type: Examples
    url: examples/mobile-login-request-example.json
  - type: Examples
    url: examples/mobile-mark-offers-read-request-example.json
  - type: Examples
    url: examples/mobile-transaction-details-example.json
  - type: Examples
    url: examples/mobile-transaction-details-request-example.json
  - type: Examples
    url: examples/mobile-update-user-profile-request-example.json
  - type: Examples
    url: examples/mobile-user-session-example.json
  - type: JSONLD
    url: json-ld/punchh-mobile-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-mobile.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-mobile.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-online-ordering
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-online-ordering
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-online-ordering/make-your-first-sso-api-call
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-checkin-request-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-checkin-response-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-redemption-request-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-redemption-response-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-checkin-request-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-checkin-response-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-redemption-request-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-redemption-response-structure.json
  - type: Examples
    url: examples/online-ordering-online-order-checkin-request-example.json
  - type: Examples
    url: examples/online-ordering-online-order-checkin-response-example.json
  - type: Examples
    url: examples/online-ordering-online-order-redemption-request-example.json
  - type: Examples
    url: examples/online-ordering-online-order-redemption-response-example.json
  - type: JSONLD
    url: json-ld/punchh-online-ordering-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-online-ordering.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-online-ordering.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-platform-functions
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-platform-functions
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-platform-functions/make-your-first-platform-function-api-call
  - type: JSONSchema
    url: json-schema/platform-functions-redeemable-schema.json
  - type: JSONStructure
    url: json-structure/platform-functions-redeemable-structure.json
  - type: Examples
    url: examples/platform-functions-redeemable-example.json
  - type: JSONLD
    url: json-ld/punchh-platform-functions-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-platform-functions.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-platform-functions.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-pos
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-pos
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-pos/make-your-first-pos-api-call
- aid: punchh:punchh-auth-api
  name: Punchh Auth API
  description: The Auth API from Punchh — 14 operation(s) for auth.
  humanURL: https://developers.partech.com/docs/dev-portal-mobile
  baseURL: https://{server_name}.punchh.com
  tags:
  - Authentication
  tags_raw:
  - Auth
  properties:
  - type: OpenAPI
    url: openapi/punchh-auth-api-openapi.yml
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-mobile
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-mobile
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-mobile/make-your-first-mobile-api-call
  - type: JSONSchema
    url: json-schema/mobile-access-token-schema.json
  - type: JSONSchema
    url: json-schema/mobile-create-user-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-login-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-mark-offers-read-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-transaction-details-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-transaction-details-schema.json
  - type: JSONSchema
    url: json-schema/mobile-update-user-profile-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-user-session-schema.json
  - type: JSONStructure
    url: json-structure/mobile-access-token-structure.json
  - type: JSONStructure
    url: json-structure/mobile-create-user-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-login-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-mark-offers-read-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-transaction-details-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-transaction-details-structure.json
  - type: JSONStructure
    url: json-structure/mobile-update-user-profile-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-user-session-structure.json
  - type: Examples
    url: examples/mobile-access-token-example.json
  - type: Examples
    url: examples/mobile-create-user-request-example.json
  - type: Examples
    url: examples/mobile-login-request-example.json
  - type: Examples
    url: examples/mobile-mark-offers-read-request-example.json
  - type: Examples
    url: examples/mobile-transaction-details-example.json
  - type: Examples
    url: examples/mobile-transaction-details-request-example.json
  - type: Examples
    url: examples/mobile-update-user-profile-request-example.json
  - type: Examples
    url: examples/mobile-user-session-example.json
  - type: JSONLD
    url: json-ld/punchh-mobile-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-mobile.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-mobile.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-online-ordering
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-online-ordering
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-online-ordering/make-your-first-sso-api-call
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-checkin-request-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-checkin-response-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-redemption-request-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-redemption-response-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-checkin-request-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-checkin-response-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-redemption-request-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-redemption-response-structure.json
  - type: Examples
    url: examples/online-ordering-online-order-checkin-request-example.json
  - type: Examples
    url: examples/online-ordering-online-order-checkin-response-example.json
  - type: Examples
    url: examples/online-ordering-online-order-redemption-request-example.json
  - type: Examples
    url: examples/online-ordering-online-order-redemption-response-example.json
  - type: JSONLD
    url: json-ld/punchh-online-ordering-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-online-ordering.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-online-ordering.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-platform-functions
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-platform-functions
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-platform-functions/make-your-first-platform-function-api-call
  - type: JSONSchema
    url: json-schema/platform-functions-redeemable-schema.json
  - type: JSONStructure
    url: json-structure/platform-functions-redeemable-structure.json
  - type: Examples
    url: examples/platform-functions-redeemable-example.json
  - type: JSONLD
    url: json-ld/punchh-platform-functions-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-platform-functions.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-platform-functions.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-pos
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-pos
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-pos/make-your-first-pos-api-call
- aid: punchh:punchh-badges-api
  name: Punchh Badges API
  description: The Badges API from Punchh — 1 operation(s) for badges.
  humanURL: https://developers.partech.com/docs/dev-portal-mobile
  baseURL: https://{server_name}.punchh.com
  tags:
  - Badges
  properties:
  - type: OpenAPI
    url: openapi/punchh-badges-api-openapi.yml
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-mobile
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-mobile
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-mobile/make-your-first-mobile-api-call
  - type: JSONSchema
    url: json-schema/mobile-access-token-schema.json
  - type: JSONSchema
    url: json-schema/mobile-create-user-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-login-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-mark-offers-read-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-transaction-details-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-transaction-details-schema.json
  - type: JSONSchema
    url: json-schema/mobile-update-user-profile-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-user-session-schema.json
  - type: JSONStructure
    url: json-structure/mobile-access-token-structure.json
  - type: JSONStructure
    url: json-structure/mobile-create-user-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-login-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-mark-offers-read-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-transaction-details-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-transaction-details-structure.json
  - type: JSONStructure
    url: json-structure/mobile-update-user-profile-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-user-session-structure.json
  - type: Examples
    url: examples/mobile-access-token-example.json
  - type: Examples
    url: examples/mobile-create-user-request-example.json
  - type: Examples
    url: examples/mobile-login-request-example.json
  - type: Examples
    url: examples/mobile-mark-offers-read-request-example.json
  - type: Examples
    url: examples/mobile-transaction-details-example.json
  - type: Examples
    url: examples/mobile-transaction-details-request-example.json
  - type: Examples
    url: examples/mobile-update-user-profile-request-example.json
  - type: Examples
    url: examples/mobile-user-session-example.json
  - type: JSONLD
    url: json-ld/punchh-mobile-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-mobile.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-mobile.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-online-ordering
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-online-ordering
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-online-ordering/make-your-first-sso-api-call
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-checkin-request-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-checkin-response-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-redemption-request-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-redemption-response-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-checkin-request-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-checkin-response-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-redemption-request-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-redemption-response-structure.json
  - type: Examples
    url: examples/online-ordering-online-order-checkin-request-example.json
  - type: Examples
    url: examples/online-ordering-online-order-checkin-response-example.json
  - type: Examples
    url: examples/online-ordering-online-order-redemption-request-example.json
  - type: Examples
    url: examples/online-ordering-online-order-redemption-response-example.json
  - type: JSONLD
    url: json-ld/punchh-online-ordering-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-online-ordering.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-online-ordering.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-platform-functions
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-platform-functions
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-platform-functions/make-your-first-platform-function-api-call
  - type: JSONSchema
    url: json-schema/platform-functions-redeemable-schema.json
  - type: JSONStructure
    url: json-structure/platform-functions-redeemable-structure.json
  - type: Examples
    url: examples/platform-functions-redeemable-example.json
  - type: JSONLD
    url: json-ld/punchh-platform-functions-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-platform-functions.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-platform-functions.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-pos
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-pos
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-pos/make-your-first-pos-api-call
- aid: punchh:punchh-beacons-api
  name: Punchh Beacons API
  description: The Beacons API from Punchh — 2 operation(s) for beacons.
  humanURL: https://developers.partech.com/docs/dev-portal-mobile
  baseURL: https://{server_name}.punchh.com
  tags:
  - Beacons
  properties:
  - type: OpenAPI
    url: openapi/punchh-beacons-api-openapi.yml
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-mobile
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-mobile
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-mobile/make-your-first-mobile-api-call
  - type: JSONSchema
    url: json-schema/mobile-access-token-schema.json
  - type: JSONSchema
    url: json-schema/mobile-create-user-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-login-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-mark-offers-read-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-transaction-details-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-transaction-details-schema.json
  - type: JSONSchema
    url: json-schema/mobile-update-user-profile-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-user-session-schema.json
  - type: JSONStructure
    url: json-structure/mobile-access-token-structure.json
  - type: JSONStructure
    url: json-structure/mobile-create-user-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-login-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-mark-offers-read-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-transaction-details-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-transaction-details-structure.json
  - type: JSONStructure
    url: json-structure/mobile-update-user-profile-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-user-session-structure.json
  - type: Examples
    url: examples/mobile-access-token-example.json
  - type: Examples
    url: examples/mobile-create-user-request-example.json
  - type: Examples
    url: examples/mobile-login-request-example.json
  - type: Examples
    url: examples/mobile-mark-offers-read-request-example.json
  - type: Examples
    url: examples/mobile-transaction-details-example.json
  - type: Examples
    url: examples/mobile-transaction-details-request-example.json
  - type: Examples
    url: examples/mobile-update-user-profile-request-example.json
  - type: Examples
    url: examples/mobile-user-session-example.json
  - type: JSONLD
    url: json-ld/punchh-mobile-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-mobile.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-mobile.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-online-ordering
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-online-ordering
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-online-ordering/make-your-first-sso-api-call
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-checkin-request-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-checkin-response-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-redemption-request-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-redemption-response-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-checkin-request-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-checkin-response-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-redemption-request-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-redemption-response-structure.json
  - type: Examples
    url: examples/online-ordering-online-order-checkin-request-example.json
  - type: Examples
    url: examples/online-ordering-online-order-checkin-response-example.json
  - type: Examples
    url: examples/online-ordering-online-order-redemption-request-example.json
  - type: Examples
    url: examples/online-ordering-online-order-redemption-response-example.json
  - type: JSONLD
    url: json-ld/punchh-online-ordering-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-online-ordering.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-online-ordering.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-platform-functions
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-platform-functions
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-platform-functions/make-your-first-platform-function-api-call
  - type: JSONSchema
    url: json-schema/platform-functions-redeemable-schema.json
  - type: JSONStructure
    url: json-structure/platform-functions-redeemable-structure.json
  - type: Examples
    url: examples/platform-functions-redeemable-example.json
  - type: JSONLD
    url: json-ld/punchh-platform-functions-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-platform-functions.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-platform-functions.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-pos
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-pos
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-pos/make-your-first-pos-api-call
- aid: punchh:punchh-business-admin-users-api
  name: Punchh Business Admin Users API
  description: The Business Admin Users API from Punchh — 3 operation(s) for business admin users.
  humanURL: https://developers.partech.com/docs/dev-portal-mobile
  baseURL: https://{server_name}.punchh.com
  tags:
  - Business Admin Users
  properties:
  - type: OpenAPI
    url: openapi/punchh-business-admin-users-api-openapi.yml
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-mobile
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-mobile
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-mobile/make-your-first-mobile-api-call
  - type: JSONSchema
    url: json-schema/mobile-access-token-schema.json
  - type: JSONSchema
    url: json-schema/mobile-create-user-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-login-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-mark-offers-read-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-transaction-details-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-transaction-details-schema.json
  - type: JSONSchema
    url: json-schema/mobile-update-user-profile-request-schema.json
  - type: JSONSchema
    url: json-schema/mobile-user-session-schema.json
  - type: JSONStructure
    url: json-structure/mobile-access-token-structure.json
  - type: JSONStructure
    url: json-structure/mobile-create-user-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-login-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-mark-offers-read-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-transaction-details-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-transaction-details-structure.json
  - type: JSONStructure
    url: json-structure/mobile-update-user-profile-request-structure.json
  - type: JSONStructure
    url: json-structure/mobile-user-session-structure.json
  - type: Examples
    url: examples/mobile-access-token-example.json
  - type: Examples
    url: examples/mobile-create-user-request-example.json
  - type: Examples
    url: examples/mobile-login-request-example.json
  - type: Examples
    url: examples/mobile-mark-offers-read-request-example.json
  - type: Examples
    url: examples/mobile-transaction-details-example.json
  - type: Examples
    url: examples/mobile-transaction-details-request-example.json
  - type: Examples
    url: examples/mobile-update-user-profile-request-example.json
  - type: Examples
    url: examples/mobile-user-session-example.json
  - type: JSONLD
    url: json-ld/punchh-mobile-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-mobile.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-mobile.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-online-ordering
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-online-ordering
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-online-ordering/make-your-first-sso-api-call
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-checkin-request-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-checkin-response-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-redemption-request-schema.json
  - type: JSONSchema
    url: json-schema/online-ordering-online-order-redemption-response-schema.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-checkin-request-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-checkin-response-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-redemption-request-structure.json
  - type: JSONStructure
    url: json-structure/online-ordering-online-order-redemption-response-structure.json
  - type: Examples
    url: examples/online-ordering-online-order-checkin-request-example.json
  - type: Examples
    url: examples/online-ordering-online-order-checkin-response-example.json
  - type: Examples
    url: examples/online-ordering-online-order-redemption-request-example.json
  - type: Examples
    url: examples/online-ordering-online-order-redemption-response-example.json
  - type: JSONLD
    url: json-ld/punchh-online-ordering-context.jsonld
  - type: PostmanCollection
    url: collections/punchh-online-ordering.postman_collection.json
  - type: OpenCollection
    url: collections/punchh-online-ordering.opencollection.json
  - type: Documentation
    url: https://developers.partech.com/docs/dev-portal-platform-functions
  - type: APIReference
    url: https://developers.partech.com/docs/dev-portal-platform-functions
  - type: GettingStarted
    url: https://developers.partech.com/docs/dev-portal-platform-functions/make-your-first-platform-function-api-call
  - type: JSONSchema
    url: json-schema/platform-functions-redeemable-schema.json
  - type: JSONStructure
    url: json-structure/platform-functions-redeemable-structure.json
  - type: Examples
    url: examples/platform-functions-redeemable-example.json
  - type: JSONLD
    url: json-ld/punchh-platform-functions-context.jsonld


# --- truncated at 32 KB (264 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/apis.yml

Work with this as data

Every provider 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 providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
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 provider

curl "https://apis.io/api/v1/providers/punchh"

All providers

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

Every operation they expose

curl "https://apis.io/api/v1/providers/punchh/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/punchh/evidence"

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.

GitHub Google LinkedIn

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