Punchh

Punchh Users API

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

GitHub OpenAPI

Operations 43

POST /api2/mobile/users/login Sign in #
POST /api2/mobile/users/connect_with_facebook Log in With Facebook #
POST /api2/mobile/apple_registrations Log in With Apple #
DELETE /api2/mobile/users/logout Log out #
GET /api2/mobile/users/profile Fetch User Information #
PUT /api2/mobile/users Update User Profile #
POST /api2/mobile/users Sign up / Register #
DELETE /api2/mobile/users Request for Account Deletion #
POST /api2/mobile/users/forgot_password Forgot Password #
GET /api2/mobile/users/account_history User Account History #
PUT /api2/mobile/user_relations/{id} Update User Relation #
DELETE /api2/mobile/user_relations/{id} Delete User Relation #
POST /api2/mobile/user_relations Create User Relation #
POST /api2/mobile/users/send_verification_email Send Verification Email #
POST /api2/mobile/session_tokens Get User Session Token #
PATCH /api2/mobile/async_users Asynchronous User Update #
POST /api2/mobile/aws_s3_pre_signed_url Image Upload to AWS #
GET /api2/mobile/users/balance Fetch User Balance #
POST /api2/mobile/conversions Point Conversion #
GET /api2/mobile/deals List All Deals #
POST /api2/mobile/deals Save Selected Deal #
GET /api2/mobile/estimate_points Estimate Points Earning #
GET /api2/mobile/balance_timelines Balance Timelines #
POST /api2/mobile/user_enrollments User Enrollment #
PATCH /api2/mobile/user_enrollments User Disenrollment #
GET /api2/mobile/deals/{redeemable_uuid} Get Deal Details #
GET /api2/mobile/users/lifetime_stats Lifetime Stats #
GET /api2/mobile/users/points_expiry_timeline Fetch Rolling Points Expiry #
POST /api2/mobile/users/google_sign_in Log in With Google #
POST /api2/mobile/users/request_reactivation Reactivate User Profile #
POST /api2/dashboard/users/ban Ban a User #
DELETE /api2/dashboard/users/ban Unban a User #
POST /api2/dashboard/users/send_message Send Message to a User #
POST /api2/dashboard/users/reactivate Reactivate a User #
DELETE /api2/dashboard/users/deactivate Deactivate a User #
DELETE /api2/dashboard/users Delete a User #
PATCH /api2/dashboard/users Update a User #
POST /api2/dashboard/users/send_user_details_export Get User Export #
GET /api2/dashboard/users/extensive_timeline Get Extended User History #
GET /api2/dashboard/user_favourite_locations Fetch User Favorite Locations #
DELETE /api2/dashboard/user_favourite_locations Delete User Favorite Location #
GET /api2/dashboard/users/info Get User Information #
GET /api2/dashboard/users/redemption Redemption Look-up #

Documentation

📖
Documentation
https://developers.partech.com/docs/dev-portal-mobile
📖
APIReference
https://developers.partech.com/docs/dev-portal-mobile
📖
GettingStarted
https://developers.partech.com/docs/dev-portal-mobile/make-your-first-mobile-api-call
📖
Documentation
https://developers.partech.com/docs/dev-portal-online-ordering
📖
APIReference
https://developers.partech.com/docs/dev-portal-online-ordering
📖
GettingStarted
https://developers.partech.com/docs/dev-portal-online-ordering/make-your-first-sso-api-call
📖
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
📖
Documentation
https://developers.partech.com/docs/dev-portal-pos
📖
APIReference
https://developers.partech.com/docs/dev-portal-pos
📖
GettingStarted
https://developers.partech.com/docs/dev-portal-pos/make-your-first-pos-api-call

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/openapi/punchh-users-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-access-token-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-create-user-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-login-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-mark-offers-read-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-transaction-details-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-transaction-details-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-update-user-profile-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-user-session-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-access-token-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-create-user-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-login-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-mark-offers-read-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-transaction-details-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-transaction-details-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-update-user-profile-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-user-session-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-checkin-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-checkin-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-redemption-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/online-ordering-online-order-redemption-response-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-checkin-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-checkin-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-redemption-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/online-ordering-online-order-redemption-response-structure.json
📊
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

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-access-token-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-create-user-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-login-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-mark-offers-read-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-transaction-details-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-transaction-details-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-update-user-profile-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/mobile-user-session-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-ld/punchh-mobile-context.jsonld
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-mobile.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-mobile.opencollection.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-checkin-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-checkin-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-redemption-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/examples/online-ordering-online-order-redemption-response-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-ld/punchh-online-ordering-context.jsonld
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-online-ordering.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/collections/punchh-online-ordering.opencollection.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

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/punchh-users-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

GitHub Google LinkedIn

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

OpenAPI Specification

punchh-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Punchh Users API
  version: '1.0'
  description: 'Operations tagged Users across 2 of this provider''s published API definitions: punchh-mobile-api-openapi.yml, punchh-platform-functions-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://SERVER_NAME_GOES_HERE.punchh.com
tags:


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