Punchh · JSON Structure

Mobile Login Request Structure

LoginRequest schema from PAR Punchh Mobile API

Type: object Properties: 2 Required: 2
RestaurantLoyaltyMarketingGuest EngagementOnline OrderingMobilePoint Of SaleWebhooks

LoginRequest is a JSON Structure definition published by Punchh, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

client user

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-structure/mobile-login-request-structure.json",
  "name": "LoginRequest",
  "description": "LoginRequest schema from PAR Punchh Mobile API",
  "type": "object",
  "properties": {
    "client": {
      "type": "string",
      "description": "OAuth client ID provided by the business.",
      "example": "business_client_key"
    },
    "user": {
      "type": "object",
      "required": [
        "email",
        "password"
      ],
      "properties": {
        "email": {
          "type": "string",
          "example": "jsmith@example.com"
        },
        "password": {
          "type": "string",
          "example": "example"
        }
      }
    }
  },
  "required": [
    "client",
    "user"
  ]
}