Punchh · Schema

UserSession

UserSession schema from PAR Punchh Mobile API

RestaurantLoyaltyMarketingGuest EngagementOnline OrderingMobilePoint Of SaleWebhooks

Properties

Name Type Description
access_token object
user object Guest profile with loyalty information and generated codes.
View JSON Schema on GitHub

JSON Schema

mobile-user-session-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "UserSession",
  "description": "UserSession schema from PAR Punchh Mobile API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/punchh/refs/heads/main/json-schema/mobile-user-session-schema.json",
  "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": "integer",
          "example": "example"
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "user": {
      "type": "object",
      "description": "Guest profile with loyalty information and generated codes."
    }
  }
}