# Punchh Users API

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

Punchh Users API is one of 46 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 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.

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

## Operations (43)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (61)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/openapi/punchh-users-api-openapi.yml
- **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
- **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
- **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
- **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
- **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
- …and 21 more, listed in full on the page.

## Other Punchh APIs (12)

- [Punchh POS API](https://apis.io/apis/punchh/punchh-pos-api/)
- [Punchh Api2 API](https://apis.io/apis/punchh/punchh-api2-api/)
- [Punchh Auth API](https://apis.io/apis/punchh/punchh-auth-api/)
- [Punchh Badges API](https://apis.io/apis/punchh/punchh-badges-api/)
- [Punchh Beacons API](https://apis.io/apis/punchh/punchh-beacons-api/)
- [Punchh Business Admin Users API](https://apis.io/apis/punchh/punchh-business-admin-users-api/)
- [Punchh Business Migration Users API](https://apis.io/apis/punchh/punchh-business-migration-users-api/)
- [Punchh Challenges API](https://apis.io/apis/punchh/punchh-challenges-api/)
- [Punchh Check In API](https://apis.io/apis/punchh/punchh-check-in-api/)
- [Punchh Check Ins API](https://apis.io/apis/punchh/punchh-check-ins-api/)
- [Punchh Check User Balance API](https://apis.io/apis/punchh/punchh-check-user-balance-api/)
- [Punchh Collectibles API](https://apis.io/apis/punchh/punchh-collectibles-api/)

## Tags

User

---

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