Otter · Schema

EnrollmentField

EnrollmentField schema from Public API (Otter Public API).

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name	Type	Description
key	string	The key of field, will be used in the Create User API.
required	boolean	Whether this field is required when creating a user.
type	string	The type of field, frontend can use type to decide which input to use. i.e. use a date picker for DATE type, use a text input for EMAIL/FULL_NAME type.
label	string	This can be used as the field input's label on the frontend.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EnrollmentField",
  "description": "EnrollmentField schema from Public API (Otter Public API).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-enrollment-field-schema.json",
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "The key of field, will be used in the Create User API.",
      "example": "full_name"
    },
    "required": {
      "type": "boolean",
      "description": "Whether this field is required when creating a user.",
      "example": true
    },
    "type": {
      "type": "string",
      "description": "The type of field, frontend can use type to decide which input to use. i.e. use a date picker for DATE type, use a text input for EMAIL/FULL_NAME type.",
      "example": "FULL_NAME",
      "enum": [
        "TEXT",
        "NUMBER",
        "EMAIL",
        "PASSWORD",
        "PHONE",
        "DATE",
        "DATE_TIME",
        "URL",
        "FULL_NAME",
        "ADDRESS"
      ]
    },
    "label": {
      "type": "string",
      "description": "This can be used as the field input's label on the frontend.",
      "example": "First Name and Last Name"
    }
  }
}