Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/flipdish-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Flipdish API - Apps Accounts Users API
version: v1.0
description: Flipdish Open API v1.0 — 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: help@flipdish.com
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: Users
description: Operations for Users.
paths:
/api/v1.0/users/roles:
get:
tags:
- Users
operationId: GetRoles
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiStringArrayResult'
examples:
GetRoles200Example:
summary: Default GetRoles 200 response
x-microcks-default: true
value:
Data:
- string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetRoles400Example:
summary: Default GetRoles 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:
GetRoles401Example:
summary: Default GetRoles 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:
GetRoles403Example:
summary: Default GetRoles 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:
GetRoles500Example:
summary: Default GetRoles 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 Roles
description: Get Roles via the Flipdish Open API v1.0 (GET /api/v1.0/users/roles).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/users/{userId}:
get:
tags:
- Users
operationId: GetUserById
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
description: The user id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_UserInfo_'
examples:
GetUserById200Example:
summary: Default GetUserById 200 response
x-microcks-default: true
value:
Data:
PhoneNumber: '+353000000000'
Email: owner@example.com
EmailConfirmed: true
PreventFromUsingCards: true
IsUserPhoneNumberBlocked: true
UserWhiteLabels: []
UserId: 500123
UserName: Example Name
CustomerName: Example Name
HasLoggedIn: true
DisableAppRatingControl: true
GloballyOptedOut: true
CompletedOrderCount: 3
CancelledOrderCount: 3
OrderTotalValue: 12.5
TsMostRecentOrder: '2026-06-02T12:00:00Z'
TsFirstOrder: '2026-06-02T12:00:00Z'
IsRestaurantUser: true
Installs: []
DeliveryLocations: []
PaymentAccounts: []
LanguageId: '500123'
CurrentLanguageName: Example Name
Languages: []
SalesForceContactId: '500123'
StripeCustomerId: '500123'
UserMonthlyCommissions: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetUserById400Example:
summary: Default GetUserById 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:
GetUserById401Example:
summary: Default GetUserById 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:
GetUserById403Example:
summary: Default GetUserById 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:
GetUserById500Example:
summary: Default GetUserById 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 User by Id
description: Get User by Id via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/users/{userId}/roles:
get:
tags:
- Users
operationId: GetRolesAndUnassignedRoles
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
description: The user id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_UserRole_'
examples:
GetRolesAndUnassignedRoles200Example:
summary: Default GetRolesAndUnassignedRoles 200 response
x-microcks-default: true
value:
Data:
RolesUserIn:
- string
RolesUserNotIn:
- string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetRolesAndUnassignedRoles400Example:
summary: Default GetRolesAndUnassignedRoles 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:
GetRolesAndUnassignedRoles401Example:
summary: Default GetRolesAndUnassignedRoles 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:
GetRolesAndUnassignedRoles403Example:
summary: Default GetRolesAndUnassignedRoles 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:
GetRolesAndUnassignedRoles500Example:
summary: Default GetRolesAndUnassignedRoles 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 Roles and Unassigned Roles
description: Get Roles and Unassigned Roles via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/roles).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/users/{userId}/UserNotes:
get:
tags:
- Users
operationId: GetUserNotes
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
description: The user id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_UserNote_'
examples:
GetUserNotes200Example:
summary: Default GetUserNotes 200 response
x-microcks-default: true
value:
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetUserNotes400Example:
summary: Default GetUserNotes 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:
GetUserNotes401Example:
summary: Default GetUserNotes 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:
GetUserNotes403Example:
summary: Default GetUserNotes 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:
GetUserNotes500Example:
summary: Default GetUserNotes 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 User Notes
description: Get User Notes via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/UserNotes).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/users/{userId}/orders/{orderId}:
get:
tags:
- Users
operationId: GetUserOrderByIdForAdmin
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
description: The user id path parameter.
example: 500123
- name: orderId
in: path
required: true
schema:
type: integer
format: int32
description: The order id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_Order_'
examples:
GetUserOrderByIdForAdmin200Example:
summary: Default GetUserOrderByIdForAdmin 200 response
x-microcks-default: true
value:
Data:
Store:
Id: 500123
Name: Example Name
MenuId: 500123
MenuPublishId: 00000000-0000-0000-0000-000000000000
Metadata: {}
Currency: EUR
Coordinates: {}
StoreTimezone: string
StoreIanaTimezone: string
StoreGroupId: 500123
TaxId: '500123'
PrettyAddress: string
CountryCode: IE
PropertyId: '500123'
Customer:
Id: 500123
Name: Example Name
EmailAddress: owner@example.com
PhoneNumberLocalFormat: '2026-06-02T12:00:00Z'
PhoneNumber: '+353000000000'
LanguagePreference: string
Voucher:
VoucherId: 500123
Name: Example Name
Description: string
Code: string
Amount: 12.5
Type: PercentageDiscount
SubType: None
Fees:
FeeAmount: 12.5
PercentageRate: 1.0
PerTransactionFee: 12.5
OrderItems: []
DeliveryLocation:
Coordinates: {}
Building: string
Street: string
Town: string
PostCode: string
DeliveryInstructions: string
PrettyAddressString: string
CustomerLocation:
Latitude: 1.0
Longitude: 1.0
MaskedPhoneNumber:
IsEnabled: true
PhoneNumber: '+353000000000'
Code: string
DropOffLocationId: 500123
DropOffLocation: string
AcceptedFor: '2026-06-02T12:00:00Z'
InFraudZone: true
UnusualHighValueOrder: true
RejectedByUserId: 500123
ChannelOrderId: '500123'
ChannelOrderDisplayId: '500123'
Channel:
ChannelId: 500123
TranslationKey: string
Source: Internal
LogoUri: https://api.flipdish.co/example
Available: true
MaintainedExternally: true
OrderDropOffLocation:
OrderId: 500123
LocationName: Example Name
LocationAreaName: Example Name
LocationId: 500123
LocationAreaId: 500123
ExternalLocationId: '500123'
FulfillmentStatus:
StatusId: '500123'
StatusName: Example Name
Icon: string
OrderBatchInfo:
Id: 500123
DisplayCode: string
CreateTime: '2026-06-02T12:00:00Z'
IsPublished: true
TaxItems: []
CreatedCampaignVoucherId: 500123
OrderId: 500123
LocalOrderId: '500123'
DeliveryType: Delivery
PickupLocationType: TakeOut
TableServiceCatagory: Generic
TipAmount: 12.5
DeliveryAmount: 12.5
OrderItemsAmount: 12.5
ServiceChargeAmount: 12.5
ServiceChargePercentage: 1.0
Amount: 12.5
ProcessingFee: 12.5
PaymentAccountType: Card
PaymentAccountDescription: string
OrderState: Created
IsPreOrder: true
PlacedTime: '2026-06-02T12:00:00Z'
RequestedForTime: '2026-06-02T12:00:00Z'
ChefNote: string
AppType: Unknown
UserRating: 1
PaymentStatus: Paid
RejectionReason: TooBusy
RefundedAmount: 12.5
DeliveryTrackingStatus: Unassigned
DriverId: 500123
TotalTax: 12.5
OrderTrackingCode: string
DeliveryFeeAreaId: 500123
ReceiptCode: string
TotalDepositReturnFeeAmount: 12.5
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetUserOrderByIdForAdmin400Example:
summary: Default GetUserOrderByIdForAdmin 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetUserOrderByIdForAdmin401Example:
summary: Default GetUserOrderByIdForAdmin 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:
GetUserOrderByIdForAdmin403Example:
summary: Default GetUserOrderByIdForAdmin 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:
GetUserOrderByIdForAdmin404Example:
summary: Default GetUserOrderByIdForAdmin 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetUserOrderByIdForAdmin500Example:
summary: Default GetUserOrderByIdForAdmin 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 User Order by Id for Admin
description: Get User Order by Id for Admin via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/orders/{orderId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/users/{userId}/RestaurantUserStores:
get:
tags:
- Users
operationId: GetRestaurantUserStores
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
description: The user id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_UserStoreInfo_'
examples:
GetRestaurantUserStores200Example:
summary: Default GetRestaurantUserStores 200 response
x-microcks-default: true
value:
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetRestaurantUserStores400Example:
summary: Default GetRestaurantUserStores 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:
GetRestaurantUserStores401Example:
summary: Default GetRestaurantUserStores 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:
GetRestaurantUserStores403Example:
summary: Default GetRestaurantUserStores 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:
GetRestaurantUserStores500Example:
summary: Default GetRestaurantUserStores 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 Restaurant User Stores
description: Get Restaurant User Stores via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/RestaurantUserStores).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/users/{userId}/RestaurantUserAccounts:
get:
tags:
- Users
operationId: GetRestaurantUserAccounts
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
description: The user id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_UserFlipdishAccount_'
examples:
GetRestaurantUserAccounts200Example:
summary: Default GetRestaurantUserAccounts 200 response
x-microcks-default: true
value:
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetRestaurantUserAccounts400Example:
summary: Default GetRestaurantUserAccounts 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:
GetRestaurantUserAccounts401Example:
summary: Default GetRestaurantUserAccounts 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:
GetRestaurantUserAccounts403Example:
summary: Default GetRestaurantUserAccounts 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:
GetRestaurantUserAccounts500Example:
summary: Default GetRestaurantUserAccounts 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 Restaurant User Accounts
description: Get Restaurant User Accounts via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/RestaurantUserAccounts).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/users/{userId}/previousordercount/{storeId}:
get:
tags:
- Users
operationId: GetPreviousOrderCountForStore
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
# --- truncated at 32 KB (184 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-users-api-openapi.yml