How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Punchh

Punchh Users API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Punchh Users API is one of 46 APIs that Punchh publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 26 JSON Schema definitions.

Tagged areas include User. 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 26 JSON Schemas.

This API exposes 43 operations across 35 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://SERVER_NAME_GOES_HERE.punchh.com.

43 operations 35 paths 26 schemas 7 DELETE13 GET3 PATCH18 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{server_name}.punchh.com
Resource Areas
1

Paths & Operations 43

Across 35 paths, the API surfaces 43 operations — 7 DELETE, 13 GET, 3 PATCH, 18 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 43
POST
/api2/mobile/users/login
Sign in
mobile_signin 5 params body → 200400401412422
POST
/api2/mobile/users/connect_with_facebook
Log in With Facebook
mobile_connect_with_facebook 5 params body → 200412422
POST
/api2/mobile/apple_registrations
Log in With Apple
mobile_login_with_apple 4 params body → 200
DELETE
/api2/mobile/users/logout
Log out
mobile_logout 7 params body → 200400401403422
GET
/api2/mobile/users/profile
Fetch User Information
mobile_fetch_user_information 6 params body → 200
PUT
/api2/mobile/users
Update User Profile
mobile_update_user_profile 7 params body → 200401422
POST
/api2/mobile/users
Sign up / Register
mobile_sign_up 6 params body → 200422
DELETE
/api2/mobile/users
Request for Account Deletion
delete-api2-mobile-users 5 params body → 200400401412422
POST
/api2/mobile/users/forgot_password
Forgot Password
mobile_forgot_password 5 params body → 200400401
GET
/api2/mobile/users/account_history
User Account History
mobile_user_account_history 6 params body → 200
PUT
/api2/mobile/user_relations/{id}
Update User Relation
mobile_update_user_relation 8 params body → 200401403404422
DELETE
/api2/mobile/user_relations/{id}
Delete User Relation
user_delete_user_relation 6 params body → 200400401404412
POST
/api2/mobile/user_relations
Create User Relation
mobile_create_user_relation 6 params body → 200400401403422
POST
/api2/mobile/users/send_verification_email
Send Verification Email
mobile_send_verification_email 6 params body → 200
POST
/api2/mobile/session_tokens
Get User Session Token
mobile_get_user_token 5 params body → 200
PATCH
/api2/mobile/async_users
Asynchronous User Update
mobile_asynchronous_user_update 5 params body → 202
POST
/api2/mobile/aws_s3_pre_signed_url
Image Upload to AWS
mobile_image_upload_to_aws 5 params body → 200400401
GET
/api2/mobile/users/balance
Fetch User Balance
mobile_fetch_user_balance 6 params body → 200422
POST
/api2/mobile/conversions
Point Conversion
mobile_point_conversion_API 5 params body → 200422
GET
/api2/mobile/deals
List All Deals
mobile_list_all_deals 5 params body → 200
POST
/api2/mobile/deals
Save Selected Deal
mobile_save_selected_deal 5 params body → 200
GET
/api2/mobile/estimate_points
Estimate Points Earning
mobile_estimate_points 5 params body → 200
GET
/api2/mobile/balance_timelines
Balance Timelines
mobile_balance_timelines 5 params body → 200
POST
/api2/mobile/user_enrollments
User Enrollment
mobile_user_enrollment 5 params body → 200400404417
PATCH
/api2/mobile/user_enrollments
User Disenrollment
mobile_user_disenrollment 5 params body → 200400404
GET
/api2/mobile/deals/{redeemable_uuid}
Get Deal Details
mobile_get_details_of_the_deal 7 params body → 200
GET
/api2/mobile/users/lifetime_stats
Lifetime Stats
mobile_lifetime_stats 5 params body → 200
GET
/api2/mobile/users/points_expiry_timeline
Fetch Rolling Points Expiry
rolling_points_expiry 5 params body → 200422
POST
/api2/mobile/users/google_sign_in
Log in With Google
post-api2-mobile-users-google_sign_in 5 params body → 200400422
POST
/api2/mobile/users/request_reactivation
Reactivate User Profile
post-api2-mobile-users-request_reactivation 6 params body → 200422
POST
/api2/dashboard/users/ban
Ban a User
dashboard_ban_user 1 param body → 202401
DELETE
/api2/dashboard/users/ban
Unban a User
dashboard_unban_user 2 params → 200401
POST
/api2/dashboard/users/send_message
Send Message to a User
dashboard_send_message_to_user 1 param body → 201401422
POST
/api2/dashboard/users/reactivate
Reactivate a User
dashboard_reactivate_user 2 params → 200
DELETE
/api2/dashboard/users/deactivate
Deactivate a User
dashboard_deactivate_user 2 params → 200
DELETE
/api2/dashboard/users
Delete a User
dashboard_delete_user 1 param body → 200404422
PATCH
/api2/dashboard/users
Update a User
dashboard_users_update 4 params body → 200422
POST
/api2/dashboard/users/send_user_details_export
Get User Export
dashboard_get_user_export 1 param body → 200401
GET
/api2/dashboard/users/extensive_timeline
Get Extended User History
dashboard_get_extended_user_history 2 params → 200
GET
/api2/dashboard/user_favourite_locations
Fetch User Favorite Locations
dashboard_fetch_user_favourite_locations 2 params → 200
DELETE
/api2/dashboard/user_favourite_locations
Delete User Favorite Location
dashboard_delete_user_favourite_locations 3 params → 200
GET
/api2/dashboard/users/info
Get User Information
get-api2-dashboard-users-info 1 param body → 200401404422
GET
/api2/dashboard/users/redemption
Redemption Look-up
get-api2-dashboard-users-redemption 2 params body → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are user-info (60 properties), User-object (46 properties), User (42 properties), user-input (35 properties). Each schema is shown below with its type and property counts.

Notifications
array
Returns the details of the notifications received by a user. A maximum of 10 notifications will be fetched.
menu-items
array
This object used in the API request contains one or more menu items added to an order. It is mandatory to provide an array of menu items. See [How To Send Menu…
User-object
object
Includes details about the users who are registered on a particular business
46 properties
Event-details-object
object
Returned in the response of the [User Account History](/docs/dev-portal-mobile/f340773e6bef7-user-account-history) API.
11 properties
redemption_details
object
Returns the details of a redemption done by a user
13 properties
hero-content
object
This is the first visual content that a user encounters when the user views a rich message. This can be an image or a video. json { "type": "image", "url": "IM…
4 properties
Converted-Category-Balance
array
Coupons
array
background-content
object
This is the content that makes the background of the message. json { "type": "image", "url": "IMAGEURLGOESHERE", "alttext": "Black Background Image", "initialf…
4 properties
user-relation-attribute
object
Contains information about the relationship details of a user, for example, spouse and kid information. If the user account does not have relationship details,…
5 properties
response-menu-items
array
Returns a list of menu items in the API response
UserBalanceMessages
object
Returned in response to the [Fetch User Balance](/docs/dev-portal-mobile/fb962621d8f10-fetch-user-balance) API
4 properties
profile_field_answers
object
Answers given by the user while filling in the user profile. The user submits answers to profile field questions that are configured in the Punchh platform. A…
3 properties
access_token-Object
object
An access token is needed to identify the user making the API request.
5 properties
account-balance-details
object
15 properties
cta
array
Short for call to action, a device designed to prompt an immediate response from a user json [ { "type": "externalweblink", "link": "URLGOESHERE", "label": "Mo…
rewards
array
Contains information about the available rewards of the user
user-info
object
Includes details about the users who are registered on a particular business
60 properties
User
object
Includes details about the users who are registered on a particular business
42 properties
user-relation-attributes
array
Contains information about the relationship details of a user, for example, spouse and kid information. If the user account does not have relationship details,…
user-input
object
35 properties
rewards_2
array
Contains information about the available rewards of the user. If a user account does not have rewards, the API returns an empty object in the response.
subscriptions
array
Contains information about different subscriptions issued to the user. This object is returned when the subscriptions feature is available for the business. If…
balance
object
Contains information about the account balance of the user
16 properties
discount-details
object
List of a discount's defining attributes
1 property
discounts-applied
object
Contains details of the discounts applied to a transaction
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

punchh-users-api-openapi.yml Raw ↑

Other APIs Punchh publishes across the network.

Punchh POS API
AE Profile APIs.io
Punchh Api2 API
AE Profile APIs.io
Punchh Auth API
AE Profile APIs.io
Punchh Badges API
AE Profile APIs.io
Punchh Beacons API
AE Profile APIs.io
Punchh Business Admin Users API
AE Profile APIs.io
Punchh Business Migration Users API
AE Profile APIs.io
Punchh Challenges API
AE Profile APIs.io
Punchh Check In API
AE Profile APIs.io
Punchh Check Ins API
AE Profile APIs.io
Punchh Check User Balance API
AE Profile APIs.io
Punchh Collectibles API
AE Profile APIs.io
#User
← Back to P APIs
API Details
ID
punchh:punchh-users-api
Base URL
https://{server_name}.punchh.com
Docs
https://developers.partech.com/docs/dev-portal-mobile
Provider
Punchh
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=punchh-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/punchh-users-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Punchh Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.