Punchh · JSON Structure

Mobile User Session Structure

UserSession schema from PAR Punchh Mobile API

Type: object Properties: 2
RestaurantLoyaltyMarketingGuest EngagementOnline OrderingMobilePoint Of SaleWebhooks

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

Properties

access_token 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-user-session-structure.json",
  "name": "UserSession",
  "description": "UserSession schema from PAR Punchh Mobile API",
  "type": "object",
  "properties": {
    "access_token": {
      "title": "AccessToken",
      "type": "object",
      "x-schema-source": "documentation",
      "properties": {
        "token": {
          "type": "string",
          "example": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
        },
        "refresh_token": {
          "type": "string",
          "example": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
        },
        "seconds_to_expire": {
          "type": "int32",
          "example": "example"
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "user": {
      "type": "object",
      "description": "Guest profile with loyalty information and generated codes."
    }
  }
}