# Panoptes API

> Panoptes is a production-based restaurant operating system for Iraq. Its API lets a restaurant owner or their developer reach every action a user can take — POS, KDS, menu and catalog, inventory and production, purchasing, delivery channels, cash and loss control, accounting, HR and payroll, reports — plus webhooks for every audited change and an MCP server for AI agents.

Key facts for integration:

- Production base URL: https://api.panoptesos.com
- Staging base URL: https://staging-api.panoptesos.com
- All routes are versioned under `/api/v1`.
- Machine auth: send header `X-Api-Key: pnp_<env>_<8hex>.<secret>`. Console routes accept it when the key holds the matching `cap:<capability>` scope.
- Session auth (a dashboard you build): send header `Authorization: Bearer <console JWT>`.
- Console routes answer `{ success, data, message, code, errors }`; the public API answers `{ ok, data }` / `{ ok, error: { code, message } }`. `code` is the HTTP status number.
- Request and response JSON fields are camelCase.
- Amounts are in the branch currency (IQD by default). Writes that move money or stock take an `Idempotency-Key` header.

Tip for AI assistants: fetch https://docs.panoptesos.com/llms-full.txt for the complete guides and endpoint catalogue in one file, and https://docs.panoptesos.com/panoptes-openapi.json for the machine-readable OpenAPI 3.0 spec.

## Guides

### Getting Started

- [Getting Started](https://docs.panoptesos.com/docs/getting-started/): Create an API key and make your first Panoptes API call.
- [Environments & Base URLs](https://docs.panoptesos.com/docs/environments/): Staging and production hosts, route families and headers.

### Authentication

- [API Key Authentication](https://docs.panoptesos.com/docs/authentication/): Mint API keys and authenticate machine-to-machine calls.
- [Permissions & Scopes](https://docs.panoptesos.com/docs/scopes/): One scope per capability, presets, and the legacy aliases.

### Guides

- [Responses & Errors](https://docs.panoptesos.com/docs/errors/): The two envelopes, numeric error codes, pagination and idempotency.
- [Webhooks](https://docs.panoptesos.com/docs/webhooks/): Subscribe to every audited change, verify signatures, handle retries.
- [Realtime (SignalR)](https://docs.panoptesos.com/docs/realtime/): Console events over SignalR for dashboards you build.

### MCP

- [MCP Overview](https://docs.panoptesos.com/docs/mcp/): What the Panoptes MCP server is, and how an AI agent uses it.
- [Connect a Client](https://docs.panoptesos.com/docs/mcp-connect/): Claude Code, Claude Desktop, Cursor and OAuth connectors.
- [Tool Reference](https://docs.panoptesos.com/docs/mcp-tools/): Every MCP tool, what it answers, and its main parameters.
- [Actions (list_actions / call_action)](https://docs.panoptesos.com/docs/mcp-actions/): Let an agent change data safely through the REST pipeline.

## API Reference

- [All endpoints (611)](https://docs.panoptesos.com/api-reference/)
- [Accounting Exports (2)](https://docs.panoptesos.com/api-reference/accounting-exports/)
- [Accounts (7)](https://docs.panoptesos.com/api-reference/accounts/)
- [Advances (6)](https://docs.panoptesos.com/api-reference/advances/)
- [Aging (2)](https://docs.panoptesos.com/api-reference/aging/)
- [Announcements (1)](https://docs.panoptesos.com/api-reference/announcements/)
- [API Keys (7)](https://docs.panoptesos.com/api-reference/api-keys/)
- [Approval Requests (5)](https://docs.panoptesos.com/api-reference/approval-requests/)
- [Attendance (3)](https://docs.panoptesos.com/api-reference/attendance/)
- [Audit Chain (4)](https://docs.panoptesos.com/api-reference/audit-chain/)
- [Audit Logs (3)](https://docs.panoptesos.com/api-reference/audit-logs/)
- [Auth (16)](https://docs.panoptesos.com/api-reference/auth/)
- [Bank (9)](https://docs.panoptesos.com/api-reference/bank/)
- [Batch Capacity (3)](https://docs.panoptesos.com/api-reference/batch-capacity/)
- [Batch Templates (3)](https://docs.panoptesos.com/api-reference/batch-templates/)
- [Branch Groups (6)](https://docs.panoptesos.com/api-reference/branch-groups/)
- [Branch Memberships (4)](https://docs.panoptesos.com/api-reference/branch-memberships/)
- [Branches (5)](https://docs.panoptesos.com/api-reference/branches/)
- [Brands (6)](https://docs.panoptesos.com/api-reference/brands/)
- [Channel Product Map (3)](https://docs.panoptesos.com/api-reference/channel-product-map/)
- [Channel Receivables (1)](https://docs.panoptesos.com/api-reference/channel-receivables/)
- [Channels (5)](https://docs.panoptesos.com/api-reference/channels/)
- [Check In (5)](https://docs.panoptesos.com/api-reference/check-in/)
- [Combos (5)](https://docs.panoptesos.com/api-reference/combos/)
- [Connectors (2)](https://docs.panoptesos.com/api-reference/connectors/)
- [Consumable BOM (3)](https://docs.panoptesos.com/api-reference/consumable-bom/)
- [Cost Cards (3)](https://docs.panoptesos.com/api-reference/cost-cards/)
- [Cost Recalculation (2)](https://docs.panoptesos.com/api-reference/cost-recalculation/)
- [Count Corrections (1)](https://docs.panoptesos.com/api-reference/count-corrections/)
- [Currencies (1)](https://docs.panoptesos.com/api-reference/currencies/)
- [Customer Invoices (12)](https://docs.panoptesos.com/api-reference/customer-invoices/)
- [Dashboards (5)](https://docs.panoptesos.com/api-reference/dashboards/)
- [Delivery Policies (3)](https://docs.panoptesos.com/api-reference/delivery-policies/)
- [Delivery Reviews (4)](https://docs.panoptesos.com/api-reference/delivery-reviews/)
- [Delivery Settlements (6)](https://docs.panoptesos.com/api-reference/delivery-settlements/)
- [Dining Areas (4)](https://docs.panoptesos.com/api-reference/dining-areas/)
- [Dining Tables (7)](https://docs.panoptesos.com/api-reference/dining-tables/)
- [Employee Documents (3)](https://docs.panoptesos.com/api-reference/employee-documents/)
- [Employees (8)](https://docs.panoptesos.com/api-reference/employees/)
- [End-of-Day Reports (5)](https://docs.panoptesos.com/api-reference/end-of-day-reports/)
- [Exchange Rates (2)](https://docs.panoptesos.com/api-reference/exchange-rates/)
- [Export Jobs (5)](https://docs.panoptesos.com/api-reference/export-jobs/)
- [Export Presets (4)](https://docs.panoptesos.com/api-reference/export-presets/)
- [Floor (1)](https://docs.panoptesos.com/api-reference/floor/)
- [Floor Seating (2)](https://docs.panoptesos.com/api-reference/floor-seating/)
- [Franchisees (5)](https://docs.panoptesos.com/api-reference/franchisees/)
- [Fraud Cases (5)](https://docs.panoptesos.com/api-reference/fraud-cases/)
- [Guest · Menu (1)](https://docs.panoptesos.com/api-reference/guest-menu/)
- [Guest · Self Order (3)](https://docs.panoptesos.com/api-reference/guest-self-order/)
- [Guest Payments (3)](https://docs.panoptesos.com/api-reference/guest-payments/)
- [HQ (3)](https://docs.panoptesos.com/api-reference/hq/)
- [HR Dashboard (2)](https://docs.panoptesos.com/api-reference/hr-dashboard/)
- [HR Notifications (4)](https://docs.panoptesos.com/api-reference/hr-notifications/)
- [Idempotency Keys (3)](https://docs.panoptesos.com/api-reference/idempotency-keys/)
- [Integrity Alerts (2)](https://docs.panoptesos.com/api-reference/integrity-alerts/)
- [Inventory Counts (8)](https://docs.panoptesos.com/api-reference/inventory-counts/)
- [Inventory Items (6)](https://docs.panoptesos.com/api-reference/inventory-items/)
- [Journal (3)](https://docs.panoptesos.com/api-reference/journal/)
- [KDS Board (2)](https://docs.panoptesos.com/api-reference/kds-board/)
- [KDS Stations (4)](https://docs.panoptesos.com/api-reference/kds-stations/)
- [Kitchen Transfers (4)](https://docs.panoptesos.com/api-reference/kitchen-transfers/)
- [Leave (3)](https://docs.panoptesos.com/api-reference/leave/)
- [Ledger Lock (4)](https://docs.panoptesos.com/api-reference/ledger-lock/)
- [Legal Entities (5)](https://docs.panoptesos.com/api-reference/legal-entities/)
- [Loss Capture (4)](https://docs.panoptesos.com/api-reference/loss-capture/)
- [Loss Summary (4)](https://docs.panoptesos.com/api-reference/loss-summary/)
- [Media Images (9)](https://docs.panoptesos.com/api-reference/media-images/)
- [Modifiers (7)](https://docs.panoptesos.com/api-reference/modifiers/)
- [Module Vocabularies (54)](https://docs.panoptesos.com/api-reference/module-vocabularies/)
- [OAuth 2.0 (3)](https://docs.panoptesos.com/api-reference/oauth-2-0/)
- [OAuth Clients (4)](https://docs.panoptesos.com/api-reference/oauth-clients/)
- [Online Menu (7)](https://docs.panoptesos.com/api-reference/online-menu/)
- [Order Courses (1)](https://docs.panoptesos.com/api-reference/order-courses/)
- [Org Units (6)](https://docs.panoptesos.com/api-reference/org-units/)
- [Organizations (6)](https://docs.panoptesos.com/api-reference/organizations/)
- [Outbox (3)](https://docs.panoptesos.com/api-reference/outbox/)
- [Payroll (6)](https://docs.panoptesos.com/api-reference/payroll/)
- [Performance Reviews (2)](https://docs.panoptesos.com/api-reference/performance-reviews/)
- [Periods (6)](https://docs.panoptesos.com/api-reference/periods/)
- [Pilots (6)](https://docs.panoptesos.com/api-reference/pilots/)
- [POS Orders (8)](https://docs.panoptesos.com/api-reference/pos-orders/)
- [Pos Reference (1)](https://docs.panoptesos.com/api-reference/pos-reference/)
- [Price Preview (2)](https://docs.panoptesos.com/api-reference/price-preview/)
- [Price Variance (4)](https://docs.panoptesos.com/api-reference/price-variance/)
- [Product Categories (5)](https://docs.panoptesos.com/api-reference/product-categories/)
- [Product Import (3)](https://docs.panoptesos.com/api-reference/product-import/)
- [Production Batches (8)](https://docs.panoptesos.com/api-reference/production-batches/)
- [Products (9)](https://docs.panoptesos.com/api-reference/products/)
- [Promotions (6)](https://docs.panoptesos.com/api-reference/promotions/)
- [Public · Catalog (3)](https://docs.panoptesos.com/api-reference/public-catalog/)
- [Public · Inventory (2)](https://docs.panoptesos.com/api-reference/public-inventory/)
- [Public · Menu Images (1)](https://docs.panoptesos.com/api-reference/public-menu-images/)
- [Public · Orders (3)](https://docs.panoptesos.com/api-reference/public-orders/)
- [Purchase Approvals (3)](https://docs.panoptesos.com/api-reference/purchase-approvals/)
- [Purchase Invoices (6)](https://docs.panoptesos.com/api-reference/purchase-invoices/)
- [Purchase Orders (8)](https://docs.panoptesos.com/api-reference/purchase-orders/)
- [Receipts (3)](https://docs.panoptesos.com/api-reference/receipts/)
- [Receiving Discrepancies (2)](https://docs.panoptesos.com/api-reference/receiving-discrepancies/)
- [Reconciliation (5)](https://docs.panoptesos.com/api-reference/reconciliation/)
- [Recruitment (7)](https://docs.panoptesos.com/api-reference/recruitment/)
- [Regions (4)](https://docs.panoptesos.com/api-reference/regions/)
- [Reorder (2)](https://docs.panoptesos.com/api-reference/reorder/)
- [Report Builder (8)](https://docs.panoptesos.com/api-reference/report-builder/)
- [Report Subscriptions (5)](https://docs.panoptesos.com/api-reference/report-subscriptions/)
- [Reports (3)](https://docs.panoptesos.com/api-reference/reports/)
- [Sale Invoices (4)](https://docs.panoptesos.com/api-reference/sale-invoices/)
- [Sales Channels (1)](https://docs.panoptesos.com/api-reference/sales-channels/)
- [Sales Integrity (3)](https://docs.panoptesos.com/api-reference/sales-integrity/)
- [Setup (2)](https://docs.panoptesos.com/api-reference/setup/)
- [Shelf Life (2)](https://docs.panoptesos.com/api-reference/shelf-life/)
- [Shifts (4)](https://docs.panoptesos.com/api-reference/shifts/)
- [Statements (6)](https://docs.panoptesos.com/api-reference/statements/)
- [Stock Locations (6)](https://docs.panoptesos.com/api-reference/stock-locations/)
- [Stock Movements (3)](https://docs.panoptesos.com/api-reference/stock-movements/)
- [Subscription (3)](https://docs.panoptesos.com/api-reference/subscription/)
- [Supplier Payments (4)](https://docs.panoptesos.com/api-reference/supplier-payments/)
- [Suppliers (7)](https://docs.panoptesos.com/api-reference/suppliers/)
- [Tax Codes (6)](https://docs.panoptesos.com/api-reference/tax-codes/)
- [Three Way Match (2)](https://docs.panoptesos.com/api-reference/three-way-match/)
- [Transfer Orders (13)](https://docs.panoptesos.com/api-reference/transfer-orders/)
- [Usage Variance (2)](https://docs.panoptesos.com/api-reference/usage-variance/)
- [Users (8)](https://docs.panoptesos.com/api-reference/users/)
- [Vault (5)](https://docs.panoptesos.com/api-reference/vault/)
- [Violations (2)](https://docs.panoptesos.com/api-reference/violations/)
- [Vocabularies (9)](https://docs.panoptesos.com/api-reference/vocabularies/)
- [Webhooks (16)](https://docs.panoptesos.com/api-reference/webhooks/)

## Tools & machine-readable

- [OpenAPI 3.0 spec](https://docs.panoptesos.com/panoptes-openapi.json)
- [Postman collection](https://docs.panoptesos.com/postman/Panoptes.postman_collection.json)
- [Postman environment — staging](https://docs.panoptesos.com/postman/Panoptes.staging.postman_environment.json)
- [Postman environment — production](https://docs.panoptesos.com/postman/Panoptes.production.postman_environment.json)
- [Full docs for LLMs](https://docs.panoptesos.com/llms-full.txt)