Flipdish Customers & Accounts API
Manage customers, platform users, teammates, accounts, and delivery drivers.
OpenAPI Specification
{
"openapi": "3.0.3",
"info": {
"title": "Flipdish API - Customers",
"version": "v1.0",
"description": "Flipdish Open API v1.0 \u2014 Customers 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": "Accounts",
"description": "Operations for Accounts."
},
{
"name": "Customers",
"description": "Operations for Customers."
},
{
"name": "Drivers",
"description": "Operations for Drivers."
},
{
"name": "Teammates",
"description": "Operations for Teammates."
},
{
"name": "Users",
"description": "Operations for Users."
}
],
"paths": {
"/api/v1.0/accounts": {
"get": {
"tags": [
"Accounts"
],
"operationId": "GetAccountDetails",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_AccountDetail_"
},
"examples": {
"GetAccountDetails200Example": {
"summary": "Default GetAccountDetails 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"Email": "[email protected]",
"SignupSteps": [],
"IsVerified": true,
"IsSelfServeUser": true,
"AccountId": 500123,
"Name": "Example Name",
"Language": "string",
"TimeZoneInfoId": "500123",
"DisplayTimesInUserLocalTimeZone": true,
"ShowHiddenFeatures": true,
"CreatedAt": "2026-06-02T12:00:00Z"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetAccountDetails400Example": {
"summary": "Default GetAccountDetails 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": {
"GetAccountDetails401Example": {
"summary": "Default GetAccountDetails 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": {
"GetAccountDetails403Example": {
"summary": "Default GetAccountDetails 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": {
"GetAccountDetails500Example": {
"summary": "Default GetAccountDetails 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 Account Details",
"description": "Get Account Details via the Flipdish Open API v1.0 (GET /api/v1.0/accounts).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
},
"put": {
"tags": [
"Accounts"
],
"operationId": "UpdateAccount",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountDetailBase"
},
"examples": {
"UpdateAccountRequestExample": {
"summary": "Default UpdateAccount request",
"x-microcks-default": true,
"value": {
"Name": "Example Name",
"Language": "string",
"TimeZoneInfoId": "500123",
"DisplayTimesInUserLocalTimeZone": true,
"ShowHiddenFeatures": true,
"CreatedAt": "2026-06-02T12:00:00Z"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"UpdateAccount400Example": {
"summary": "Default UpdateAccount 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": {
"UpdateAccount401Example": {
"summary": "Default UpdateAccount 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": {
"UpdateAccount403Example": {
"summary": "Default UpdateAccount 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": {
"UpdateAccount500Example": {
"summary": "Default UpdateAccount 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 Update Account",
"description": "Update Account via the Flipdish Open API v1.0 (PUT /api/v1.0/accounts).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
},
"post": {
"tags": [
"Accounts"
],
"operationId": "CreateAccount",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAccountModel"
},
"examples": {
"CreateAccountRequestExample": {
"summary": "Default CreateAccount request",
"x-microcks-default": true,
"value": {
"Email": "[email protected]",
"StoreName": "Example Name",
"LanguageId": "500123",
"Rid": 500123,
"Cid": "500123",
"RecaptchaToken": "string"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"CreateAccount400Example": {
"summary": "Default CreateAccount 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": {
"CreateAccount401Example": {
"summary": "Default CreateAccount 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": {
"CreateAccount403Example": {
"summary": "Default CreateAccount 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": {
"CreateAccount500Example": {
"summary": "Default CreateAccount 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 Create Account",
"description": "Create Account via the Flipdish Open API v1.0 (POST /api/v1.0/accounts).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/accounts/timezones": {
"get": {
"tags": [
"Accounts"
],
"operationId": "GetLocalisedTimeZones",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiArrayResult_LocalisedTimeZone_"
},
"examples": {
"GetLocalisedTimeZones200Example": {
"summary": "Default GetLocalisedTimeZones 200 response",
"x-microcks-default": true,
"value": {
"Data": []
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetLocalisedTimeZones400Example": {
"summary": "Default GetLocalisedTimeZones 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": {
"GetLocalisedTimeZones401Example": {
"summary": "Default GetLocalisedTimeZones 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": {
"GetLocalisedTimeZones403Example": {
"summary": "Default GetLocalisedTimeZones 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": {
"GetLocalisedTimeZones500Example": {
"summary": "Default GetLocalisedTimeZones 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 Localised Time Zones",
"description": "Get Localised Time Zones via the Flipdish Open API v1.0 (GET /api/v1.0/accounts/timezones).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/accounts/password": {
"put": {
"tags": [
"Accounts"
],
"operationId": "ChangePassword",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangePasswordModel"
},
"examples": {
"ChangePasswordRequestExample": {
"summary": "Default ChangePassword request",
"x-microcks-default": true,
"value": {
"OldPassword": "string",
"NewPassword": "string"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"ChangePassword400Example": {
"summary": "Default ChangePassword 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": {
"ChangePassword401Example": {
"summary": "Default ChangePassword 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": {
"ChangePassword403Example": {
"summary": "Default ChangePassword 403 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"ChangePassword409Example": {
"summary": "Default ChangePassword 409 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": {
"ChangePassword500Example": {
"summary": "Default ChangePassword 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 Change Password",
"description": "Change Password via the Flipdish Open API v1.0 (PUT /api/v1.0/accounts/password).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
},
"post": {
"tags": [
"Accounts"
],
"operationId": "PasswordResetWithToken",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PasswordResetModel"
},
"examples": {
"PasswordResetWithTokenRequestExample": {
"summary": "Default PasswordResetWithToken request",
"x-microcks-default": true,
"value": {
"TokenId": "500123",
"Email": "[email protected]",
"Password": "string",
"PasswordConfirmation": "string",
"Token": "string"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"PasswordResetWithToken400Example": {
"summary": "Default PasswordResetWithToken 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": {
"PasswordResetWithToken401Example": {
"summary": "Default PasswordResetWithToken 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": {
"PasswordResetWithToken403Example": {
"summary": "Default PasswordResetWithToken 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": {
"PasswordResetWithToken500Example": {
"summary": "Default PasswordResetWithToken 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 Password Reset with Token",
"description": "Password Reset with Token via the Flipdish Open API v1.0 (POST /api/v1.0/accounts/password).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/accounts/password/pin": {
"put": {
"tags": [
"Accounts"
],
"operationId": "ChangePasswordWithPin",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetPasswordWithPinModel"
},
"examples": {
"ChangePasswordWithPinRequestExample": {
"summary": "Default ChangePasswordWithPin request",
"x-microcks-default": true,
"value": {
"Pin": 1,
"NewPassword": "string",
"RecaptchaToken": "string"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"ChangePasswordWithPin400Example": {
"summary": "Default ChangePasswordWithPin 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": {
# --- truncated at 32 KB (495 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-customers-openapi.json