List Restaurants

List all restaurants with branding information

Authentication

x-np-api-keystring
API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Headers

x-api-versiondateOptional

Used for API versioning. More details.

Response

This endpoint returns a list of objects.
idUUID
The unique system identifier for the restaurant
codestring
The restaurant code
namestring
The restaurant name
seatingSetupLastUpdateddatetime

When the seating setup (seatings or seating locations) was last modified (UTC). Use to decide whether to invalidate cached dining topology.

descriptionstringOptional
Restaurant description
primaryColorstringOptional
Primary brand color as hex code
secondaryColorstringOptional
Secondary brand color as hex code
logoUrlstringOptional
Cloudflare URL for the restaurant logo
backgroundUrlstringOptional

Cloudflare URL for the restaurant menu background image (displayed behind the menu in the POS UI). Omitted when no background is set.