Short Menu’s API is in active development. We only have a very limited set of APIs available, but are expanding constantly. If you have a use-case that isn’t considered in our API, please don’t hesitate to reach out at [email protected].

Base URL

Short Menu’s REST API is served over HTTPS. The base URL for all endpoints is:

https://api.shortmenu.com

Authentication

All API endpoints are authenticated using API Keys. To authenticate, you need to include the x-api-key header with a Short Menu API Key.

You can create API Keys at shrtm.nu/create-api-key.

x-api-key: <Your-API-Key>

Response Codes

Short Menu’s API uses standard HTTP status codes to indicate the result of a request. Here are the most common response codes:

CodeDescription
200Indicates that the request has succeeded.
201Indicates that the request has succeeded and a new resource has been created as a result.
400The request could not be processed by the server due to an incorrect payload.
401The request needs authentication.
404The requested resource could not be found.

OpenAPI Spec

The OpenAPI spec of our API is available for download at shrtm.nu/openapi.