Otter · Schema

UserField

UserField schema from Public API (Otter Public API).

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
key string The key of field, this is retrieved from GetEnrollmentConfig API call.
value string The value of the field.
View JSON Schema on GitHub

JSON Schema

public-api-user-field-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "UserField",
  "description": "UserField schema from Public API (Otter Public API).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-user-field-schema.json",
  "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"
    }
  }
}