Getting Started With Platform Functions API Integrations

This documentation is intended to provide comprehensive information for admin users of the Punchh platform. Many of the settings and available actions are dependent upon an appropriate level of access to platform APIs.

All platform APIs require an admin key as a part of the authentication, which can be generated from the Punchh platform. See Make Your First Platform Function API Call for more information.

Note: Once regenerated, the old admin key expires and cannot be used for any platform-level functions.

API at a Glance

Punchh provides APIs for various scenarios:

• Location
• Business Migration
• Custom Segment
• User level operations such as ban, unban, deactivate, reactivate, delete
• Franchisee
• Eclub