{ "opencollection": "1.0.0", "info": { "name": "Flipdish API - Apps Accounts Users API", "version": "v1.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Flipdish Get Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/users/roles", "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Roles via the Flipdish Open API v1.0 (GET /api/v1.0/users/roles)." }, { "info": { "name": "Flipdish Get User by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/users/:userId", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get User by Id via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId})." }, { "info": { "name": "Flipdish Get Roles and Unassigned Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/users/:userId/roles", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Roles and Unassigned Roles via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/roles)." }, { "info": { "name": "Flipdish Get User Notes", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/users/:userId/UserNotes", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get User Notes via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/UserNotes)." }, { "info": { "name": "Flipdish Get User Order by Id for Admin", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/users/:userId/orders/:orderId", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "orderId", "value": "500123", "type": "path", "description": "The order id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get User Order by Id for Admin via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/orders/{orderId})." }, { "info": { "name": "Flipdish Get Restaurant User Stores", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/users/:userId/RestaurantUserStores", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Restaurant User Stores via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/RestaurantUserStores)." }, { "info": { "name": "Flipdish Get Restaurant User Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/users/:userId/RestaurantUserAccounts", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Restaurant User Accounts via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/RestaurantUserAccounts)." }, { "info": { "name": "Flipdish Get Previous Order Count for Store", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/users/:userId/previousordercount/:storeId", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "storeId", "value": "500123", "type": "path", "description": "The store id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Previous Order Count for Store via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/previousordercount/{storeId})." }, { "info": { "name": "Flipdish Search Flipdish Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/users/searchFlipdishAccounts", "params": [ { "name": "searchPattern", "value": "string", "type": "query", "description": "The search pattern query parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Search Flipdish Accounts via the Flipdish Open API v1.0 (GET /api/v1.0/users/searchFlipdishAccounts)." }, { "info": { "name": "Flipdish Get User Delivery Locations for Admin", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/users/:userId/deliveryLocations", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "whiteLabelId", "value": "500123", "type": "query", "description": "The white label id query parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get User Delivery Locations for Admin via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/deliveryLocations)." }, { "info": { "name": "Flipdish Create User Delivery Location", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/deliveryLocations", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create User Delivery Location via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/deliveryLocations)." }, { "info": { "name": "Flipdish Get User Orders for Admin", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/users/:userId/orders", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "skip", "value": "1", "type": "query", "description": "The skip query parameter." }, { "name": "take", "value": "1", "type": "query", "description": "The take query parameter." }, { "name": "brandId", "value": "500123", "type": "query", "description": "The brand id query parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get User Orders for Admin via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/orders)." }, { "info": { "name": "Flipdish Get User Sms Conversation Items", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/users/:userId/smsConversationItems", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "mostRecentCount", "value": "3", "type": "query", "description": "The most recent count query parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get User Sms Conversation Items via the Flipdish Open API v1.0 (GET /api/v1.0/users/{userId}/smsConversationItems)." }, { "info": { "name": "Flipdish Search Users", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/users/search", "params": [ { "name": "searchQuery", "value": "string", "type": "query", "description": "The search query query parameter." }, { "name": "hasUserLoggedIn", "value": "true", "type": "query", "description": "The has user logged in query parameter." }, { "name": "userDiscriminator", "value": "All", "type": "query", "description": "The user discriminator query parameter." }, { "name": "searchIn", "value": "Generic", "type": "query", "description": "The search in query parameter." }, { "name": "pageIndex", "value": "1", "type": "query", "description": "The page index query parameter." }, { "name": "pageSize", "value": "1", "type": "query", "description": "The page size query parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Search Users via the Flipdish Open API v1.0 (GET /api/v1.0/users/search)." }, { "info": { "name": "Flipdish Send User Sms", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/sms", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Send User Sms via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/sms)." }, { "info": { "name": "Flipdish Reset Mfa", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/ResetMfa", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Reset Mfa via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/ResetMfa)." }, { "info": { "name": "Flipdish Add User Note", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/AddUserNote", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Add User Note via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/AddUserNote)." }, { "info": { "name": "Flipdish Anonymize User", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/AnonymizeUser", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Anonymize User via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/AnonymizeUser)." }, { "info": { "name": "Flipdish Set Customer Name", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/SetCustomerName", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Set Customer Name via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/SetCustomerName)." }, { "info": { "name": "Flipdish Send User Push Notification", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/pushNotifications", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Send User Push Notification via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/pushNotifications)." }, { "info": { "name": "Flipdish Block User Phone Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/BlockUserPhoneNumber", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Block User Phone Number via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/BlockUserPhoneNumber)." }, { "info": { "name": "Flipdish Mark User as Fraudulent", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/MarkUserAsFraudulent", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Mark User as Fraudulent via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/MarkUserAsFraudulent)." }, { "info": { "name": "Flipdish Mark User as Suspicious", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/MarkUserAsSuspicious", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Mark User as Suspicious via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/MarkUserAsSuspicious)." }, { "info": { "name": "Flipdish Unblock User Phone Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/UnblockUserPhoneNumber", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Unblock User Phone Number via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/UnblockUserPhoneNumber)." }, { "info": { "name": "Flipdish Add User to Role", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/AddUserToRole/:roleName", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "roleName", "value": "Example Name", "type": "path", "description": "The role name path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Add User to Role via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/AddUserToRole/{roleName})." }, { "info": { "name": "Flipdish Set User Language", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/SetLanguage/:languageId", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "languageId", "value": "500123", "type": "path", "description": "The language id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Set User Language via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/SetLanguage/{languageId})." }, { "info": { "name": "Flipdish Remove User from Role", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/RemoveUserFromRole/:roleName", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "roleName", "value": "Example Name", "type": "path", "description": "The role name path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove User from Role via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/RemoveUserFromRole/{roleName})." }, { "info": { "name": "Flipdish Set Flipdish Account Id for User", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/SetFlipdishAccountId/:accountId", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "accountId", "value": "500123", "type": "path", "description": "The account id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Set Flipdish Account Id for User via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/SetFlipdishAccountId/{accountId})." }, { "info": { "name": "Flipdish Remove Flipdish Account Id for User", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/RemoveFlipdishAccountId/:accountId", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "accountId", "value": "500123", "type": "path", "description": "The account id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove Flipdish Account Id for User via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/RemoveFlipdishAccountId/{accountId})." }, { "info": { "name": "Flipdish Hide User Delivery Location", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/deliveryLocations/:deliveryLocationId/hide", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "deliveryLocationId", "value": "500123", "type": "path", "description": "The delivery location id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Hide User Delivery Location via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/hide)." }, { "info": { "name": "Flipdish Set User Delivery Location Field", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/deliveryLocations/:deliveryLocationId/fields", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "deliveryLocationId", "value": "500123", "type": "path", "description": "The delivery location id path parameter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Set User Delivery Location Field via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/fields)." }, { "info": { "name": "Flipdish Set User Delivery Location Coordinates", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/users/:userId/deliveryLocations/:deliveryLocationId/coordinates", "params": [ { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "deliveryLocationId", "value": "500123", "type": "path", "description": "The delivery location id path parameter." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Set User Delivery Location Coordinates via the Flipdish Open API v1.0 (POST /api/v1.0/users/{userId}/deliveryLocations/{deliveryLocationId}/coordinates)." } ] } ], "bundled": true }