New Release | RME API: New Endpoints with Paginated Responses | 20 Aug 2025

What’s New?

• Export API, New Endpoints with Paginated Responses
  Existing endpoints have been recreated with paginated responses. Designed for large data sets, the paginated response provides a method of retrieving the full response in smaller segments. Existing endpoints are unaffected by this change and are still available for use

GET ingredients

/ingredients/paged
/ingredients/paged/{guid}

 For the above request, a GUID is mandatory. Valid GUIDs are group or category GUIDs only.

GET menus

/menus/paged

GET recipes

/recipes/paged
/recipes/paged/{guid}

•  For the above request, a GUID is mandatory. Valid GUIDs are group or category GUIDs only

The new endpoints are available to users who already have credentials for the Export API.

•  To request access to the Export API, please submit a request to Fourth's Support team

The new endpoints' responses include information about the number of records per page, the current page and the total number of records in the response. This information will help API consumers navigate through the paginated data

• When making the request, the PageSize parameter can be used to control the size of the data subset in the response
• The default PageSize value is 1000 for ingredients and recipes. For menus, it is 250
• Using the CurrentPage parameter, users can navigate through the data incrementally, accessing specific pages as needed
• Pagination metadata is included in the API response

{
  "CurrentPage": 1,
  "TotalPages": 1184,
  "PageSize": 10,
  "TotalCount": 11838,
  "HasPrevious": false,
  "HasNext": true,
  "NextPage": 2,
  "PreviousPage": null,
  "Items": [
    {
      "RecipeGuid": "10a5f550-a2ba-48a5-87c0-9a55f86198d7",
      "PLU": "108009",
      "StarChefKey": "0001601",

Fig.1-Sample response for GET /recipes/paged

Pagination metadata properties

To provide additional flexibility, all of the new endpoints include these optional parameters:

createdAfter: Returns only records created on or after the date. Use the format: yyyy-mm-dd.

lastModifiedAfter: Returns only records modified on or after the date. Use the format: yyyy-mm-dd.

scheduledExportAfter: Returns only records with a date on or after any set "Scheduled Export After" date. This is a customer-editable field in the platform. The default value for each ingredient is the "created on" date. Use the format: yyyy-mm-dd.
 

Ingredient and recipe requests offer two additional optional parameters: 

lastNutritionModifiedAfter: Returns only records where the nutrition data has changed on or after the date. Use the format: yyyy-mm-dd.

lastNutritionModifiedBefore: Returns only records where the nutrition data has changed on or before the date. Use the format: yyyy-mm-dd. 

Release date: 20th August 2025