Otter · Schema

ViewCredential

ViewCredential schema from Public API (Otter Public API).

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name	Type	Description
key	string	The key of the credential.
label	string	The friendly name of the credential.
value	string	The value of the credential. Only returned if the Store ID was provided in the request.
inputType	string	The type of input
selectOptions	array	options to select when type is `SELECT` or `MULTI_SELECT`

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ViewCredential",
  "description": "ViewCredential schema from Public API (Otter Public API).",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-view-credential-schema.json",
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "The key of the credential.",
      "example": "userEmail"
    },
    "label": {
      "type": "string",
      "description": "The friendly name of the credential.",
      "example": "User Email"
    },
    "value": {
      "type": "string",
      "description": "The value of the credential. Only returned if the Store ID was provided in the request.",
      "example": "[email protected]"
    },
    "inputType": {
      "type": "string",
      "description": "The type of input",
      "enum": [
        "TEXT",
        "SELECT",
        "MULTI_SELECT"
      ],
      "default": "TEXT",
      "example": "TEXT"
    },
    "selectOptions": {
      "type": "array",
      "description": "options to select when type is `SELECT` or `MULTI_SELECT`",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "key",
    "label"
  ]
}