API overview

A REST + JSON API for screens, playlists, scenes, schedules, and integrations. Stable, versioned, and rate-limited.

Updated May 18, 2026·4 min read

Base URL

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

Versioning

The API is versioned in the URL. v1 is current; v0 is sunset. Breaking changes ship in a new major version with at least 12 months overlap.

Authentication

All requests use a workspace-scoped API key passed as a Bearer token. Keys carry the role of the user who created them.

Shell
curl https://api.menupi.com/v1/screens \
  -H "Authorization: Bearer mpi_live_••••••"

Request & response format

  • All requests and responses use JSON.
  • Timestamps are ISO 8601 (e.g. `2026-05-18T14:30:00Z`).
  • IDs are opaque strings — do not parse.
  • Unknown fields are ignored on input, included on output.

Idempotency

For POST and PATCH requests, pass an `Idempotency-Key` header. Retries with the same key return the same result, even if the original request succeeded.