Get a summary of all available menus

get

/api/v2/menus/summary

{basePath}/menus/summary?orgShortName=tfoinc&locRef= fdmnh144& rvcRef=42

API returns a list of menu summaries for a location or revenue center in an organization.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

A collection of menu summary items.
Body ()
Root Schema : schema
Type: object
Show Source
  • items
    Array of Menu Summary objects. If there are no menus configured that meet the query parameters, this array will be empty.
Nested Schema : items
Type: array
Array of Menu Summary objects. If there are no menus configured that meet the query parameters, this array will be empty.
Show Source
Nested Schema : MenuSummary
Type: object
Summary details of a menu without its related items.
Show Source
Nested Schema : MenuSummaryProperties
Type: object
Show Source
Nested Schema : OrgLocRvcProperties
Type: object
A collection of properties for orgShortName, locRef and rvcRef
Show Source

401 Response

401 Unauthorized
Headers
  • Bearer authentication challenge. When token validation fails, the header may include error and error_description parameters.

    The following conditions and HTTP response examples are illustrative and not exhaustive. Error descriptions may vary.

    No token provided: No access token is provided, or the Authorization request header is missing. The response header is WWW-Authenticate: Bearer, without error or error_description parameters.

    Example:

    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: Bearer

    Expired token: The access token has expired. The timestamp in this example is illustrative.

    Example:

    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: Bearer error="invalid_token", error_description="The token expired at '05/19/2026 17:16:29'"

    Signing key not found: The token cannot be validated because its signing key was not found. For example, the token's key ID (kid) does not match a key in the JSON Web Key Set (JWKS) used for validation.

    Example:

    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: Bearer error="invalid_token", error_description="The signature key was not found"

    Invalid signature: The token signature is invalid. For example, the token may have been modified.

    Example:

    HTTP/1.1 401 Unauthorized
    WWW-Authenticate: Bearer error="invalid_token", error_description="The signature is invalid"

    For the missing-token, signing-key-not-found, and invalid-signature examples above, the response body is empty. The authentication error details are provided in the WWW-Authenticate response header.

    The response may include an additional WWW-Authenticate header containing a bare Bearer challenge alongside the challenge shown in these examples.

Back to Top

Examples

Example Request Body

Not applicable for this endpoint.

Example Response Body

The following example shows the contents of the response body in JSON format:


{
  "items": [
    {
      "orgShortName": "mymeal",
      "locRef": "store66",
      "rvcRef": 2,
      "menuId": "myb:store2:dining",
      "name": "1"
    }
  ]
}
Back to Top