--- updatedAt: 2026-08-26T15:21:01.000Z --- Fetch the complete documentation index at: https://developers.flipdish.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version. # API Overview Integrate with Flipdish: manage orgs, menus, sales, webhooks, and more via REST APIs with OAuth2 authentication. The Flipdish API is a REST API that lets you programmatically manage orgs, menus, sales, store operations, audit logs, and webhooks on the Flipdish platform. The current API version is **v3.0**. Consumer Orders endpoints remain available on [v1.0](https://developers.flipdish.com/v1.0/reference/get-app-config). ## Base URL All API requests should be made to: ```text https://api.flipdish.co ``` ## Authentication The Flipdish API uses **OAuth2 client credentials** for authentication. See [Getting Started with Flipdish API](https://developers.flipdish.com/docs/getting-started) for a step-by-step walkthrough of creating your Flipdish App and obtaining an access token. ## API Resources | Resource | Description | API Reference | | --------------------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Org Management | Create and manage orgs | [View endpoints](https://developers.flipdish.com/reference/getallorgs) | | Menu Management | Create, update, and publish menus | [View endpoints](https://developers.flipdish.com/reference/get__menumanagement_orgs__orgid_menus_headers_0) | | Sales | Query sales (orders that have been accepted by the kitchen) | [View endpoints](https://developers.flipdish.com/reference/post__salesmanagement_orgs__orgid_sales_0) | | Consumer Orders | Place and track customer orders (v1.0) | [View endpoints](https://developers.flipdish.com/v1.0/reference/get-app-config) | | Operations Updates | Publish menus and manage store operations | [View endpoints](https://developers.flipdish.com/reference/post__operations_updates_orgs__orgid_properties__propertyid_saleschannels__saleschannelid_menu_publish_status_0) | | Audit Logs | Query audit log entries | [View endpoints](https://developers.flipdish.com/reference/post__auditlogs_orgs__orgid_0) | | Webhook Subscriptions | Create and manage webhook subscriptions | [View endpoints](https://developers.flipdish.com/reference/listwebhooksubscriptions) | | Webhook Events | Event schemas for real-time notifications | [View schemas](https://developers.flipdish.com/reference/post_menu-published-v1) | > 📘 Orders vs Sales > > An *order* is the customer's request to buy; a *sale* is the merchant's accepted transaction. Once an order is accepted and committed for fulfilment, it becomes a sale — the record that operations, finance, and reporting systems use. Consumer Orders remain on v1.0; Sales endpoints are available on v3.0. ## Common Integration Scenarios * **Property, Brand and Sales Channel Management** — Manage your org's properties, brands, and sales channels via the [Org Management API](https://developers.flipdish.com/reference/getallorgs). * **Menu Management** — Create and publish menus programmatically. See [Menu Structure v3.0](https://developers.flipdish.com/docs/menu-structure-v3). * **Webhooks** — Receive real-time event notifications when things happen in your account. See [Subscribe to Flipdish Events](https://developers.flipdish.com/docs/webhooks-v3). * **POS Integration** — Receive orders, map menus, and sync with your point-of-sale system. See [Build a POS Integration](https://developers.flipdish.com/docs/build-a-pos-integration). ## SDKs ### v3.0 Client Libraries * **Org Management (TypeScript/JavaScript)** — [@flipdish/orgmanagement](https://www.npmjs.com/package/@flipdish/orgmanagement) ### v1.0 Client Libraries (Consumer Orders) These libraries cover the v1.0 API surface, including Consumer Orders endpoints: * **.NET** — [NuGet package](https://www.nuget.org/packages/Flipdish/) | [GitHub](https://github.com/flipdishbytes/api-client-csharp) * **JavaScript** — [npm package](https://www.npmjs.com/package/@flipdish/api-client-javascript) | [GitHub](https://github.com/flipdishbytes/api-client-javascript) * **TypeScript (Node.js)** — [npm package](https://www.npmjs.com/package/@flipdish/api-client-typescript) | [GitHub](https://github.com/flipdishbytes/api-client-typescript) For installation and usage examples, see [Flipdish SDK](https://developers.flipdish.com/docs/flipdish-sdk). ## Error Handling The API returns structured JSON error responses with `errorMessage` and `errorCode` fields, along with standard HTTP status codes. See [Error Handling](https://developers.flipdish.com/docs/error-handling) for response formats and status codes. ## Rate Limits Requests are subject to rate limits (50 requests per 60 seconds per IP, by default). See [Rate Limits](https://developers.flipdish.com/docs/rate-limits) for current limits, endpoint-specific overrides, and how to handle a `429` response. ## What's Next 1. **Get credentials** — [Create your Flipdish App](https://developers.flipdish.com/docs/getting-started) and request an access token. 2. **Explore the API** — Browse the interactive [API Reference](https://developers.flipdish.com/reference/getallorgs) to see all available endpoints. 3. **Set up webhooks** — [Subscribe to events](https://developers.flipdish.com/docs/webhooks-v3) to receive real-time notifications. 4. **Build your integration** — Follow a [use-case guide](#common-integration-scenarios) for step-by-step instructions. ## Need Help? If you need assistance, email us at .