Flipdish Apps & Channels API
Manage apps, mobile apps, App Store configurations, white-label config and builds, websites, and sales channels.
OpenAPI Specification
{
"openapi": "3.0.3",
"info": {
"title": "Flipdish API - Apps",
"version": "v1.0",
"description": "Flipdish Open API v1.0 \u2014 Apps operations. Flipdish is an online ordering and branded-app platform for restaurants and takeaways. This specification was derived from the official Flipdish Swagger document and grouped by resource domain.",
"contact": {
"name": "Flipdish Support",
"email": "[email protected]",
"url": "https://help.flipdish.com"
},
"x-generated-from": "https://api.flipdish.co/swagger/docs/v1.0",
"x-last-validated": "2026-06-02"
},
"servers": [
{
"url": "https://api.flipdish.co",
"description": "Flipdish production API"
}
],
"security": [
{
"oauth2": [
"api"
]
}
],
"tags": [
{
"name": "AppStore",
"description": "Operations for App Store."
},
{
"name": "AppStoreConfigurations",
"description": "Operations for App Store Configurations."
},
{
"name": "AppStoreDeveloper",
"description": "Operations for App Store Developer."
},
{
"name": "AppStoreEntitlements",
"description": "Operations for App Store Entitlements."
},
{
"name": "Apps",
"description": "Operations for Apps."
},
{
"name": "Channels",
"description": "Operations for Channels."
},
{
"name": "FirebaseApps",
"description": "Operations for Firebase Apps."
},
{
"name": "MobileApps",
"description": "Operations for Mobile Apps."
},
{
"name": "Website",
"description": "Operations for Website."
},
{
"name": "WhiteLabelBuilds",
"description": "Operations for White Label Builds."
},
{
"name": "WhiteLabelConfig",
"description": "Operations for White Label Config."
}
],
"paths": {
"/api/v1.0/apps/{appId}": {
"get": {
"tags": [
"Apps"
],
"operationId": "GetApp",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_App_"
},
"examples": {
"GetApp200Example": {
"summary": "Default GetApp 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"AppId": "500123",
"HasIosApp": true,
"IosAppStoreUrl": "https://api.flipdish.co/example",
"HasAndroidApp": true,
"AndroidPlayStoreUrl": "https://api.flipdish.co/example",
"DisplayDeliveryRestaurantScreen": true,
"LogoImageUrl": "https://api.flipdish.co/example",
"Languages": [],
"AvailableAppLanguages": [],
"AppAccessLevel": "None",
"AppResourceSet": [
"ViewApp"
],
"Features": [
"string"
],
"MapCenter": {
"Latitude": 1.0,
"Longitude": 1.0
},
"MapNorthEast": {
"Latitude": 1.0,
"Longitude": 1.0
},
"MapSouthWest": {
"Latitude": 1.0,
"Longitude": 1.0
},
"GoogleMapsApiKeyWeb": "string",
"OrgId": "500123",
"SmsRestaurantName": "Example Name",
"WebToAppRedirect": "NoRedirect",
"Name": "Example Name",
"HostName": "Example Name",
"MainColor": "string",
"KioskPrimaryColour": "string",
"ApplicationCategory": "Restaurant",
"IsPanaceaEnabled": true,
"PanaceaVanityUrl": "https://api.flipdish.co/example",
"CookieConsentPromptEnabled": true,
"CountryId": "500123"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetApp400Example": {
"summary": "Default GetApp 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Authentication has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetApp401Example": {
"summary": "Default GetApp 401 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"403": {
"description": "Successful authentication, but authorization has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetApp403Example": {
"summary": "Default GetApp 403 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"404": {
"description": "NotFound",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetApp404Example": {
"summary": "Default GetApp 404 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetApp500Example": {
"summary": "Default GetApp 500 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"api"
]
}
],
"summary": "Flipdish Get App",
"description": "Get App via the Flipdish Open API v1.0 (GET /api/v1.0/apps/{appId}).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/apps/{appId}/name": {
"get": {
"tags": [
"Apps"
],
"operationId": "GetAppName",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiStringResult"
},
"examples": {
"GetAppName200Example": {
"summary": "Default GetAppName 200 response",
"x-microcks-default": true,
"value": {
"Data": "string"
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetAppName400Example": {
"summary": "Default GetAppName 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Authentication has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetAppName401Example": {
"summary": "Default GetAppName 401 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"403": {
"description": "Successful authentication, but authorization has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetAppName403Example": {
"summary": "Default GetAppName 403 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"404": {
"description": "NotFound",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetAppName404Example": {
"summary": "Default GetAppName 404 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetAppName500Example": {
"summary": "Default GetAppName 500 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"api"
]
}
],
"summary": "Flipdish Get App Name",
"description": "Get App Name via the Flipdish Open API v1.0 (GET /api/v1.0/apps/{appId}/name).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/apps/supportedcountries": {
"get": {
"tags": [
"Apps"
],
"operationId": "GetSupportedCountries",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiArrayResult_SupportedCountry_"
},
"examples": {
"GetSupportedCountries200Example": {
"summary": "Default GetSupportedCountries 200 response",
"x-microcks-default": true,
"value": {
"Data": []
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetSupportedCountries400Example": {
"summary": "Default GetSupportedCountries 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Authentication has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetSupportedCountries401Example": {
"summary": "Default GetSupportedCountries 401 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"403": {
"description": "Successful authentication, but authorization has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetSupportedCountries403Example": {
"summary": "Default GetSupportedCountries 403 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetSupportedCountries500Example": {
"summary": "Default GetSupportedCountries 500 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"api"
]
}
],
"summary": "Flipdish Get Supported Countries",
"description": "Get Supported Countries via the Flipdish Open API v1.0 (GET /api/v1.0/apps/supportedcountries).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/apps/{appId}/compliance": {
"get": {
"tags": [
"Apps"
],
"operationId": "GetCompliance",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_AppCompliance_"
},
"examples": {
"GetCompliance200Example": {
"summary": "Default GetCompliance 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"AppId": "500123",
"ComplianceType": "Default",
"AllowDisablingOfGdpr": true
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetCompliance400Example": {
"summary": "Default GetCompliance 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Authentication has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetCompliance401Example": {
"summary": "Default GetCompliance 401 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"403": {
"description": "Successful authentication, but authorization has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetCompliance403Example": {
"summary": "Default GetCompliance 403 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetCompliance500Example": {
"summary": "Default GetCompliance 500 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"api"
]
}
],
"summary": "Flipdish Get Compliance",
"description": "Get Compliance via the Flipdish Open API v1.0 (GET /api/v1.0/apps/{appId}/compliance).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
},
"post": {
"tags": [
"Apps"
],
"operationId": "SetCompliance",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
},
{
"name": "complianceType",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"Default",
"GdprCompliance"
]
},
"description": "The compliance type query parameter.",
"example": "Default"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_AppCompliance_"
},
"examples": {
"SetCompliance200Example": {
"summary": "Default SetCompliance 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"AppId": "500123",
"ComplianceType": "Default",
"AllowDisablingOfGdpr": true
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"SetCompliance400Example": {
"summary": "Default SetCompliance 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Authentication has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"SetCompliance401Example": {
"summary": "Default SetCompliance 401 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"403": {
"description": "Successful authentication, but authorization has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"SetCompliance403Example": {
"summary": "Default SetCompliance 403 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"SetCompliance500Example": {
"summary": "Default SetCompliance 500 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"api"
]
}
],
"summary": "Flipdish Set Compliance",
"description": "Set Compliance via the Flipdish Open API v1.0 (POST /api/v1.0/apps/{appId}/compliance).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/apps/{appId}/panacea/url": {
"get": {
"tags": [
"Apps"
],
"operationId": "GetPanaceaVanityUrl",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiStringResult"
},
"examples": {
"GetPanaceaVanityUrl200Example": {
"summary": "Default GetPanaceaVanityUrl 200 response",
"x-microcks-default": true,
"value": {
"Data": "string"
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetPanaceaVanityUrl400Example": {
"summary": "Default GetPanaceaVanityUrl 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Authentication has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetPanaceaVanityUrl401Example": {
"summary": "Default GetPanaceaVanityUrl 401 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
# --- truncated at 32 KB (676 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-apps-openapi.json