Flipdish · JSON Structure

Customers Teammate Base Structure

TeammateBase schema from Flipdish API - Customers.

Type: object Properties: 4
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

AppAccessLevel HasAccessToAllStores StoreIds PropertyIds

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/flipdish/refs/heads/main/json-structure/customers-teammate-base-structure.json",
  "name": "TeammateBase",
  "description": "TeammateBase schema from Flipdish API - Customers.",
  "type": "object",
  "properties": {
    "AppAccessLevel": {
      "description": "App access level",
      "enum": [
        "None",
        "Owner",
        "StoreOwner",
        "PropertyOwner",
        "ManagedOwner",
        "Integrator",
        "PropertyManager",
        "StoreManager",
        "StoreStaff",
        "StoreReadOnlyAccess",
        "FinanceManger",
        "Onboarding",
        "Support"
      ],
      "type": "string",
      "example": "None"
    },
    "HasAccessToAllStores": {
      "description": "The user has access to all stores for the app (including new stores that added later)",
      "type": "boolean",
      "example": true
    },
    "StoreIds": {
      "description": "Store IDs the user has access to (if HasAccessToAllStores is false)",
      "type": "array",
      "items": {
        "type": "int32"
      },
      "example": [
        1
      ]
    },
    "PropertyIds": {
      "description": "Property Ids the user has access to (if HasAccessToAllStores is false)",
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "string"
      ]
    }
  }
}