Otter · JSON Structure

Public Api User Field Structure

UserField schema from Public API (Otter Public API).

Type: object Properties: 2
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

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

Properties

key value

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/otter/refs/heads/main/json-structure/public-api-user-field-structure.json",
  "name": "UserField",
  "description": "UserField schema from Public API (Otter Public API).",
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "The key of field, this is retrieved from GetEnrollmentConfig API call.",
      "example": "full_name"
    },
    "value": {
      "type": "string",
      "description": "The value of the field.",
      "example": "john doe"
    }
  }
}