# Punchh Platform Functions API

**Canonical:** https://apis.io/apis/punchh/punchh-platform-functions-api/  
**Provider:** Punchh — https://apis.io/providers/punchh/  
**Base URL:** https://{server_name}.punchh.com  
**Documentation:** https://developers.partech.com/docs/dev-portal-platform-functions

Punchh Platform Functions API is one of 15 APIs that [Punchh](https://apis.io/providers/punchh/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. Tagged areas include Business Admin Users, Business Migration Users, Check-in, Custom Segments, and Feedback. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a JSON-LD context, and 2 JSON Schemas.

This API documentation is intended to provide comprehensive information for admin users of the Punchh platform. Many of the settings and available actions depend on an appropriate level of access to Platform Functions APIs. Published by PAR on the platform functions section of the PAR developer portal; 63 operations. Certification required.

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/openapi/punchh-platform-functions-api-openapi.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/overlays/punchh-platform-functions-api-overlay.yaml
- **Documentation** — https://developers.partech.com/docs/dev-portal-platform-functions
- **APIReference** — https://developers.partech.com/docs/dev-portal-platform-functions
- **GettingStarted** — https://developers.partech.com/docs/dev-portal-platform-functions/make-your-first-platform-function-api-call
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/platform-functions-redeemable-schema.json
- **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/platform-functions-redeemable-structure.json
- **Examples** — https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/platform-functions-redeemable-example.json
- **JSONLD** — https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-ld/punchh-platform-functions-context.jsonld
- **PostmanCollection** — https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-platform-functions.postman_collection.json
- **OpenCollection** — https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-platform-functions.opencollection.json

## Other Punchh APIs (12)

- [Punchh Mobile API](https://apis.io/apis/punchh/punchh-mobile-api/)
- [Punchh Redemptions 1.0 (Legacy) API - Mobile](https://apis.io/apis/punchh/punchh-mobile-redemptions-legacy/)
- [Punchh Redemptions 2.0 (New) API - Mobile](https://apis.io/apis/punchh/punchh-mobile-redemptions-v2/)
- [Punchh Subscription API - Mobile](https://apis.io/apis/punchh/punchh-mobile-subscription/)
- [Punchh Redemptions 1.0 (Legacy) API - Online Ordering](https://apis.io/apis/punchh/punchh-online-ordering-redemptions-legacy/)
- [Punchh Redemptions 2.0 (New) API - Online Ordering](https://apis.io/apis/punchh/punchh-online-ordering-redemptions-v2/)
- [Punchh Online Ordering and SSO API](https://apis.io/apis/punchh/punchh-online-ordering-sso-api/)
- [Punchh Subscription API - Online Ordering](https://apis.io/apis/punchh/punchh-online-ordering-subscription/)
- [Punchh Headless Offers API - Platform Functions](https://apis.io/apis/punchh/punchh-platform-functions-headless-offers/)
- [Punchh Offers Ingestion API - Platform Functions](https://apis.io/apis/punchh/punchh-platform-functions-offers-ingestion/)
- [Punchh Subscription API - Platform Functions](https://apis.io/apis/punchh/punchh-platform-functions-subscription/)
- [Punchh POS API](https://apis.io/apis/punchh/punchh-pos-api/)

## Tags

Business Admin Users, Business Migration Users, Check-in, Custom Segments, Feedback, Franchisee, Locations, Meta, Redemptions, Social Cause Campaigns, Swag, User

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/punchh/punchh-platform-functions-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/punchh/.