Overview
The MealSuite API allows your facility to integrate data between your MealSuite account apps and your facility-specific systems, apps, and devices.
Authentication
A unique API authorization key is required for each account in the MealSuite system and that has designated access rights. Not all endpoints listed below may be available depending on account permission and licensed functionality.
For assistance with obtaining an API authorization key, please contact MealSuite Support. If you are MealSuite Support see the following internal article: Generating API Authorization Key for Client Account.
Webhook
If using the MealSuite API, a webhook can be implemented by MealSuite Support. A webhook will notify the client app when a MealSuite resource changes. Once the client app is notified, it sends the API request to update the object on its side.
For example, if displaying a menu on a non-MealSuite device, then when the MealSuite menu is updated, the webhook will notify the client app. The client app then sends the API request to refresh their menu with the updates.
If you are MealSuite Support, see the following internal article: Implementing a Webhook for MealSuite API.
Base Path
- Canadian Accounts: synergy.touch.mealsuite.com
- US Accounts: mealsuite.touch.mealsuite.com
- Compass Group: dineos.touch.mealsuite.com
- Unidine: myusuite.touch.mealsuite.com
Note: The hostname in the base path depends on your account's location and system.
API Endpoints
Click an endpoint to see what's included in its request and response.
Staff
- Create Staff (POST) - Add staff to Touch Admin (first name, last name, client ID, badge ID).
- All Staff (GET) - Get a list of staff members entered in your MealSuite account.
- Get Individual Staff (GET) - Retrieve individual staff member.
- Delete Staff Member (DELETE) - Delete an individual staff member.
- Re-Activate Deleted Staff Member (PUT) - Re-activate a staff member who had been deleted.
- Update Staff (PUT) - Edit an existing staff profile.
- Add Photo (POST) - Add photo to existing staff profile.
Residents/Patients
- All Residents (GET) - Get a list of list of residents/patients from your MealSuite account.
- Assign Meal Plan (POST) - Assign a meal plan with a meal plan ID.
- Update Badge ID (PUT) - Edit a badge ID.
- Cancel Meal Plan (DELETE) - Cancel/suspend a meal plan.
- Get Menu (GET) - Get a resident/patient's personal menu for specific date and meal including very limited nutritional information.
- Archive Resident (PUT) - archive a diner profile.
- Unarchive Resident (PUT) - unarchive a diner profile.
POS Operators
- Operator Listing (GET) - Get a list of all POS operators for account.
- Create Operator (POST) - Create a new POS operator.
- Update Operator (PUT) - Edit an existing POS operator.
POS Tickets
- Tickets by Date Range (GET) - Get POS ticket information by date range.
Menus
- Get Menu by POS Location (GET) - Get POS location menu details including menu items, and pricing.
- Get Menu by Menu Location (GET) - Get menu details from your MealSuite account facility.
Order History
- Get Order History (GET) - Get order history by date range.
Meal Plans
- Meal Plan Policies (GET) - Get a list of all meal plan policies and details.
- Meal Plan Account Transactions (GET) - Get meal plan transaction history for specific date range.
POS Products
- POS Products (GET) - Get a list of POS products.
Accounting Parameters
- POS GL Accounts (GET) - Get a list of GL accounts.
- POS Tax Codes (GET) - Get a list of tax codes.
Others
- POS Post Charge (POST) - override a product price for a paid transaction.
- Meal Participation (GET) - track when a resident has or has not placed an order for a selected meal service. (breakfast, lunch, dinner) and day. If a resident has not placed an order, it can indicate a wellness check may be required for that resident.
- Get Facilities (GET) - Returns list of facilities.
- Get Facility Detail (GET) - Returns a specific facility ID.