Skip to main content

MealSuite API Integration and Data Access

Kevin U
  • Updated

Overview

The MealSuite API allows your facility to securely integrate data between your MealSuite account and your facility-specific systems, apps, and devices. 

API access is granted per account; The API endpoints (listed below) that are available to your account depends on your account permissions and the functionality you are licensed for. Tell us what you want to accomplish and we will confirm what is available for your account. Common requests include the following.

To request integration access or ask about a specific data need, see Requesting an API Integration below. 

What the API Offers (Endpoints)

Staff

  • Add, update, deactivate, and reactivate staff profiles (name, client ID, badge ID)
  • Retrieve your list of staff
  • Add a photo to a staff profile

Residents/Patients

  • Retrieve your list of residents/patients
  • Assign or cancel (suspend) a meal plan
  • Update a badge ID
  • Archive or unarchive a diner profile
  • Retrieve a resident's personal menu for a specific date and meal, including very limited nutritional information

POS (Point of Sale)

  • Operators: list, create, and update POS operators
  • Tickets: retrieve POS ticket information by date range
  • Products: retrieve your list of POS products
  • Accounting: retrieve your GL accounts and tax codes
  • Post charge: override a product price for a paid transaction

Menus

  • Retrieve POS location menus, including menu items and pricing
  • Retrieve menu details for your facility's menu locations

Orders and Meal Plans

  • Retrieve order history by date range
  • Retrieve meal plan policies and details
  • Retrieve meal plan account transaction history by date range. 

Resident Wellness

  • Meal participation: see whether a resident has or has not placed an order for a selected meal service (breakfast, lunch, dinner) and day. A missing order can indicate that a wellness check is needed.

Facilities

  • Retrieve your list of facilities and the details for a specific facility.

Change Notifications (i.e., Webhook)

For an API integration, MealSuite Support can also set up a webhook notification that informs your system when something in MealSuite has changed. For example, if you show a menu on a non-MealSuite device, the notification tells your system when the menu is updated so that it can refresh the display with the latest version.

Requesting an API Integration

  1. Contact MealSuite Support at support@mealsuite.com with the following info:
    • Your facility/account name
    • What system or device you want to connect to your MealSuite account
    • What data you want to send to or receive from your MealSuite account using the list above as a guide
    • A technical contact at your facility or vendor
  2. MealSuite Support will confirm what is available for your account and licensed functionality.
  3. If it is available, Support will set up secure access for your account and provide the details your team or vendor needs.

If you are MealSuite Support, see the following internal article: Enabling API for a Client Account (INTERNAL).