# NOPOS

> NOPOS is a multi-vertical commerce and clinical backend (point of sale, bookings, payments, customers, memberships, messaging, and clinical records) exposed as one REST API. Build a POS, scheduling, or clinical front end against it: authenticate every request with an X-API-Key header, then call the JSON endpoints below.

- Base URL: `https://nopos.vercel.app/v1`
- Auth: send your developer key as the `X-API-Key` request header
- First call: `GET https://nopos.vercel.app/v1/auth/verify` returns the `store_id` your key is scoped to
- 388 endpoints across 66 groups

## Agent context

- [Full agent context](https://developers.nopos.dev/AGENTS.md): complete copy-paste grounding for AI coding tools — auth, conventions, the full endpoint catalog, and a worked POS example. Drop it in your repo as AGENTS.md / CLAUDE.md / .cursorrules.
- [OpenAPI (JSON)](https://nopos.vercel.app/docs/openapi.json): machine-readable request/response shapes — generate a typed client from this.
- [OpenAPI (YAML)](https://nopos.vercel.app/docs/openapi.yaml): same contract in YAML.
- [Swagger UI](https://nopos.vercel.app/docs/ui): browse and try endpoints.
- [Clinical planning contract](https://developers.nopos.dev/docs/planning-ai.json): table/schema planning facts for clinical workflows.

## Docs

- [Vibecode your POS](https://developers.nopos.dev/docs/vibecode): point Cursor, Claude Code, Windsurf, v0, or Lovable at NOPOS.
- [Quick start](https://developers.nopos.dev/docs/quick-start): get a key and make your first call.
- [Authentication](https://developers.nopos.dev/docs/authentication): API keys, sessions, and scopes.
- [API endpoints](https://developers.nopos.dev/docs/api/endpoints): the full reference in the portal.

## Endpoint groups

- **Authentication** — API key validation, account auth, password recovery, and key administration.
- **Users** — Profile and password management for authenticated users.
- **Customer Auth** — Customer portal registration, sessions, and self-service profile updates.
- **Stores** — Store profile, organization store lists, settings, and store lifecycle.
- **Products** — Product catalog CRUD and product archive lifecycle.
- **Services** — Service catalog, specialty matching, recommendations, and service lifecycle.
- **Inventory** — Inventory browsing and stock adjustment front ends.
- **Orders** — Order queues, order detail screens, creation flows, updates, and cancellation.
- **Payments** — Payment list, payment detail, and charge capture flows.
- **Subscriptions** — Recurring subscription CRUD and cancellation.
- **Content** — Generic content records and marketing content management.
- **Bookings** — Appointment booking, status updates, check-in, and check-out flows.
- **Customers** — Customer records, customer portal data, order history, booking history, and memberships.
- **Professionals** — Provider profiles, availability, and service assignments.
- **Classes** — Class scheduling, participants, and class bookings.
- **Categories** — Category CRUD for catalog organization.
- **Membership Tiers** — Membership plan/tier CRUD.
- **Customer Memberships** — Customer memberships, lifecycle actions, and billing history.
- **Capacity** — Bookable resources, availability blocks, and capacity checks.
- **Check-In** — Tokenized check-in links and check-in processing.
- **Patient Vitals** — Patient vital sign records for clinical workflows.
- **Waitlist** — Waitlist entries and matching.
- **Calendar Blocks** — Calendar blocks and booking-linked block cleanup.
- **Booking Resources** — Rooms and equipment available for booking flows.
- **Availability** — Next-slot search and scheduling availability helpers.
- **Packages** — Package/session bundle CRUD.
- **Platform Auth** — Staff platform sessions and clinic switching.
- **Platform Orgs** — Organizations and clinics for platform administration.
- **Platform Clinics** — Clinic staff and role administration.
- **Platform Clinical** — Clinical protocols, episodes, encounters, observations, medications, and documents.
- **Upload** — File upload helpers.
- **Slides** — Slide CRUD, image-backed slide creation, stats, and bulk updates.
- **Images** — Image generation, storage, retrieval, usage, and async image jobs.
- **AI** — AI content, slide, and image generation helpers.
- **Work Orders** — Work order CRUD for service and operations workflows.
- **Estimates** — Estimate CRUD, approval workflow, and conversion.
- **Treatment Notes** — Treatment note CRUD for clinical records.
- **Commission Schedules** — Staff commission schedule CRUD.
- **Calendar Holds** — Calendar hold lists, counts, and updates.
- **Calendar Integration** — External calendar accounts, connect callbacks, and sync.
- **Communications** — Cross-channel communications list, creation, and detail views.
- **Contacts** — Contact records, DNC history, patient linking, auto-linking, and merges.
- **Threads** — Conversation threads, assignment, status, history, and automation.
- **Clinic Phone Numbers** — Provisioned clinic phone number management.
- **Messages** — Outbound messages and segment previews.
- **Twilio Webhooks** — Signature-verified Twilio SMS webhooks.
- **Clinic Email Addresses** — Clinic email sender/address management.
- **Emails** — Outbound and inbound email flows.
- **Voice** — Voice webhooks, call list, dialing, and voice configuration.
- **Routing** — Business hours, ring groups, and missed-call automation.
- **Templates** — Message/content templates and template preview.
- **Content Library** — Reusable content library CRUD.
- **Automation** — Automation definitions, runs, scheduler hooks, and ticks.
- **Metrics** — Store-scoped daily metric ingestion, range reads, latest checks, and namespace discovery.
- **Form Deliveries** — Clinical/intake form delivery tracking.
- **Notification Logs** — Notification log list and creation.
- **Benefits** — Benefits, patient assignment, and patient benefit lookup.
- **Webhooks** — Webhook endpoint management, deliveries, and test delivery.
- **Staff Credentials** — Staff credential CRUD.
- **Resource Assignments** — Assign resources to professionals and services.
- **Reports** — Analytics endpoints for customer, revenue, and dashboard reporting.
- **Time Entries** — Staff time entry list, creation, and current-day lookup.
- **Loyalty** — Loyalty members, enrollment, awards, redemptions, and redemption history.
- **Gift Cards** — Gift card list, lookup, issue, redeem, and void workflows.
- **Developer Portal** — Developer catalog, provisioning, and API feature request routes.
- **Health and Docs** — Public health and hosted documentation endpoints.