Screens API

List, pair, update, and delete screens. Read live health.

Updated May 18, 2026·5 min read

List screens

Returns every screen the API key has scope to see.

HTTP
GET https://api.menupi.com/v1/screens

Retrieve one screen

HTTP
GET https://api.menupi.com/v1/screens/{screenId}

Pair a screen

Submit a 6-character pair code (from the player) to attach a device.

Shell
curl -X POST https://api.menupi.com/v1/screens/pair \
  -H "Authorization: Bearer mpi_live_••••••" \
  -H "Content-Type: application/json" \
  -d '{ "code": "K3VR9A", "playlist": "pl_8XR4...", "location": "loc_5J9Q..." }'

Update a screen

Shell
curl -X PATCH https://api.menupi.com/v1/screens/scr_01H... \
  -H "Authorization: Bearer mpi_live_••••••" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Drive-thru #2" }'

Delete a screen

HTTP
DELETE https://api.menupi.com/v1/screens/{screenId}

Endpoint summary

MethodPathSummary
GET/screensList all screens.
GET/screens/{id}Retrieve one screen.
POST/screens/pairAttach a device using a pair code.
PATCH/screens/{id}Update screen name, playlist, or location.
DELETE/screens/{id}Unpair and remove a screen.