API V2 Route: Meal Plan Assignments

Last updated: October 5, 2026

General Details:

Endpoint /api/v2/meal-plan-assignments and /api/v2/meal-plan-assignments/<id>
Headers Authorization: <JWT>
HTTP Methods GET
Request Body Format N/A
Response Body Format JSON
Required Scopes MEAL_PLAN_ASSIGNMENTS_GET

 

Supported Request Filters:

These filters should be query parts in the URL string and follow the standard pattern of <baseUrl>?<key>=<filter>&...

Field Name Filter Type Notes
mealPlanId number ID of the Meal Plan definition
dateCreated date or Date Filter An ISO date string or a complex Date Filter can be utilized
dateStart date or Date Filter An ISO date string or a complex Date Filter can be utilized
dateEnd date or Date Filter An ISO date string or a complex Date Filter can be utilized

 

API Response:

Field Name Data Type Notes
id string Globally unique identifier
mealPlan MealPlanThin Meal Plan associated with the assignment
dateCreated date string ISO date string
dateStart date string ISO date string
dateEnd date string ISO date string
student ProfileThin Student for which the assignment is tied to
cycle CycleThin Cycle for which the assignment is for
transaction TransactionThin Transaction associated with this assignment

 

Example Response:

{
    "entities": [
        {
            "id": "86",
            "mealPlan": {
                "id": "14",
                "name": "Commuter Plan 50",
                "externalCode": "CMP50"
            },
            "dateCreated": "2025-09-25T13:31:55.357Z",
            "dateStart": "2025-09-30T08:00:00.000Z",
            "dateEnd": "2025-12-10T23:59:59.999Z",
            "student": {
                "id": "359",
                "name": "Arthur Holland",
                "sisId": "H0034689"
            },
            "cycle": {
                "id": "8",
                "name": "Fall Semester Returning",
                "externalTermCode": "FA2026"
            },
            "transaction": {
                "id": "14687",
                "amount": "$00.01",
                "costCode": {
                  "id": "65",
                  "name": "All Commuter Meal Plans",
                  "code": "CMPA"
                }
            },
        }
    ],
    "metaData": {
        "agentId": "ab5f95b2-303a-403b-85fd-ab1d0cd8093c",
        "rateLimits": {
            "tenant": {
                "limit": 50,
                "remaining": 49,
                "reset": 1759520782000
            },
            "agent": {
                "limit": 10,
                "remaining": 9,
                "reset": 1759520783000
            }
        },
        "pagination": {
            "offset": 0,
            "limit": 1000
        }
    }
}