Flipdish · Schema

Teammate

Teammate schema from Flipdish API - Customers.

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
TeammateId	string	Unique indentifier
UserId	integer	User ID of the teammate
Name	string	Name
LastActivity	string	Last activity
AppId	string	Access level is for this App
InvitationStatus	string	Invitation status
Email	string	Email address
AppAccessLevel	string	App access level
HasAccessToAllStores	boolean	The user has access to all stores for the app (including new stores that added later)
StoreIds	array	Store IDs the user has access to (if HasAccessToAllStores is false)
PropertyIds	array	Property Ids the user has access to (if HasAccessToAllStores is false)

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/customers-teammate-schema.json",
  "title": "Teammate",
  "description": "Teammate schema from Flipdish API - Customers.",
  "type": "object",
  "properties": {
    "TeammateId": {
      "description": "Unique indentifier",
      "type": "string",
      "example": "500123"
    },
    "UserId": {
      "format": "int32",
      "description": "User ID of the teammate",
      "type": "integer",
      "nullable": true,
      "example": 500123
    },
    "Name": {
      "description": "Name",
      "type": "string",
      "example": "Example Name"
    },
    "LastActivity": {
      "format": "date-time",
      "description": "Last activity",
      "type": "string",
      "nullable": true,
      "example": "2026-06-02T12:00:00Z"
    },
    "AppId": {
      "description": "Access level is for this App",
      "type": "string",
      "example": "500123"
    },
    "InvitationStatus": {
      "description": "Invitation status",
      "enum": [
        "Pending",
        "Accepted",
        "Expired"
      ],
      "type": "string",
      "example": "Pending"
    },
    "Email": {
      "description": "Email address",
      "type": "string",
      "example": "[email protected]"
    },
    "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": {
        "format": "int32",
        "type": "integer"
      },
      "example": [
        1
      ]
    },
    "PropertyIds": {
      "description": "Property Ids the user has access to (if HasAccessToAllStores is false)",
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "string"
      ]
    }
  }
}