{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed/main/json-schema/lightspeed-user-collection-schema.json",
  "title": "User Collection",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lightspeed-users-api-openapi.yml#/components/schemas/UserCollection",
  "properties": {
    "data": {
      "description": "An array of users.",
      "items": {
        "$ref": "#/$defs/User"
      },
      "type": "array"
    },
    "version": {
      "$ref": "#/$defs/Version"
    }
  },
  "required": [
    "data",
    "version"
  ],
  "type": "object",
  "$defs": {
    "Role": {
      "properties": {
        "id": {
          "description": "Auto-generated object ID.",
          "type": "string"
        },
        "name": {
          "description": "The Role name.",
          "type": "string"
        },
        "system_role_id": {
          "description": "A system role id of the Role. Will be either '100', '200', or '300'.",
          "type": "string"
        }
      },
      "title": "Role",
      "type": "object"
    },
    "User": {
      "properties": {
        "account_type": {
          "description": "User's account type.",
          "enum": [
            "cashier",
            "manager",
            "admin"
          ],
          "type": "string"
        },
        "created_at": {
          "description": "Creation timestamp in UTC.",
          "type": "string"
        },
        "deleted_at": {
          "description": "Deletion timestamp in UTC.",
          "type": [
            "string",
            "null"
          ]
        },
        "display_name": {
          "description": "Full user's name to be used for display in the UI.",
          "type": [
            "string",
            "null"
          ]
        },
        "email": {
          "description": "User's email address.",
          "format": "email",
          "type": [
            "string",
            "null"
          ]
        },
        "email_verified_at": {
          "description": "The timestamp of users email verification.",
          "type": [
            "string",
            "null"
          ]
        },
        "enabled": {
          "description": "Indicates whether the user is enabled.",
          "type": "boolean"
        },
        "enabled_mfa": {
          "description": "The user's enabled MFA factor, or null if MFA is not enabled.",
          "properties": {
            "created_at": {
              "description": "Timestamp when the MFA factor was created.",
              "type": "string"
            },
            "id": {
              "description": "Auto-generated MFA factor ID.",
              "type": "string"
            },
            "type": {
              "description": "The MFA factor type (e.g. \"otp\").",
              "enum": [
                "otp"
              ],
              "type": "string"
            }
          },
          "type": [
            "object",
            "null"
          ]
        },
        "id": {
          "description": "Auto-generated object ID.",
          "format": "uuid",
          "type": "string"
        },
        "image_source": {
          "description": "URL of the default-sized user's avatar.",
          "type": "string"
        },
        "images": {
          "$ref": "#/$defs/UserImages"
        },
        "is_primary_user": {
          "description": "Indicated whether this user is the primary user for the account.",
          "type": "boolean"
        },
        "permissions": {
          "description": "The permissions assigned to the user.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "require_password_change": {
          "description": "Indicates whether the user is required to change their password.",
          "type": "boolean"
        },
        "restricted_outlet_id": {
          "deprecated": true,
          "description": "**deprecated** Use the `restricted_outlet_ids` instead.",
          "type": [
            "string",
            "null"
          ]
        },
        "restricted_outlet_ids": {
          "description": "A list of outlet IDs the user is associated with",
          "items": {
            "format": "uuid",
            "type": "string"
          },
          "type": "array"
        },
        "roles": {
          "description": "The roles assigned to the user.",
          "items": {
            "$ref": "#/$defs/Role"
          },
          "type": "array"
        },
        "rules": {
          "description": "The rules assigned to the user.",
          "type": "object"
        },
        "seen_at": {
          "description": "The timestamp of the user's last activity in the system.",
          "type": "string"
        },
        "switch_id": {
          "description": "The switch id for the user.",
          "type": "string"
        },
        "target_daily": {
          "description": "Daily sales target for the user.",
          "type": [
            "number",
            "null"
          ]
        },
        "target_monthly": {
          "description": "Monthly sales target for the user.",
          "type": [
            "number",
            "null"
          ]
        },
        "target_weekly": {
          "description": "Weekly sales target for the user.",
          "type": [
            "number",
            "null"
          ]
        },
        "time_until_deletion": {
          "description": "The time until the user is deleted.",
          "type": [
            "string",
            "null"
          ]
        },
        "updated_at": {
          "description": "Last update timestamp in UTC.",
          "type": "string"
        },
        "username": {
          "description": "User's username used for login.",
          "type": "string"
        },
        "version": {
          "description": "Auto-incrementing object version number.",
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "account_type",
        "created_at",
        "id",
        "is_primary_user",
        "updated_at",
        "username",
        "version"
      ],
      "title": "User",
      "type": "object"
    },
    "UserImages": {
      "description": "On object containing URLs for different sizes of the user’s avatar.",
      "properties": {
        "original": {
          "type": "string"
        },
        "sl": {
          "type": "string"
        },
        "sm": {
          "type": "string"
        },
        "ss": {
          "type": "string"
        },
        "st": {
          "type": "string"
        },
        "standard": {
          "type": "string"
        },
        "thumb": {
          "type": "string"
        }
      },
      "title": "User Image",
      "type": [
        "object",
        "null"
      ]
    },
    "Version": {
      "description": "An object containing the highest and lowest version numbers for all items of the returned collection.",
      "properties": {
        "max": {
          "description": "Highest version number of the payload, or `null` when the result set is empty.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        },
        "min": {
          "description": "Lowest version number of the payload, or `null` when the result set is empty.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "required": [
        "max",
        "min"
      ],
      "type": "object"
    }
  }
}