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

Punchh User Management API

The User Management API from Punchh — 5 operation(s) for user management.

Punchh User Management 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 Management. 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 7 operations across 5 paths, and defines 4 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.

7 operations 5 paths 4 schemas 1 DELETE2 GET1 PATCH2 POST1 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 7

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

User Management 7
POST
/api/auth/users/forgot_password
Forgot Password
sso_forgot_password 4 params body → 200412422
GET
/api/auth/users
Fetch User Information
sso_fetch_user_informaton 5 params body → 200
PUT
/api/auth/users
Update User Information
sso_update_user_information 5 params body → 200401412422
GET
/api/auth/accounts
Get Account History
sso_account_history 6 params body → 200
PATCH
/api/auth/users/change_password
Change Password
sso_change_password 5 params body → 200400
POST
/api/auth/user_enrollments
User Enrollment
sso_user_enrollment 6 params body → 200400
DELETE
/api/auth/user_enrollments
User Disenrollment
sso_user_disenrollment 6 params body → 200201400

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are user-object (49 properties), user-input-object (32 properties), profile_field_answers (3 properties). Each schema is shown below with its type and property counts.

user-input-object
object
32 properties
user-object
object
49 properties 1 required
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
user-relations
array
The object contains information about the relationship details of a user, for example, spouse and kid information. If the user account does not have relationsh…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

punchh-user-management-api-openapi.yml Raw ↑

Other APIs Punchh publishes across the network.

Punchh POS API
Punchh Api2 API
Punchh Auth API
Punchh Badges API
Punchh Beacons API
Punchh Business Admin Users API
Punchh Business Migration Users API
Punchh Challenges API
Punchh Check In API
Punchh Check Ins API
Punchh Check User Balance API
Punchh Collectibles API
Where this information came from

This is an independent, third-party profile of Punchh User Management 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.