Clarify GET API integration notes in README

[darthnithin]

Motivation

• Address documentation inaccuracies in the GET workflow diagrams that implied a server-side session cache and that scan-state returns barcode payloads.

Description

• Update README.md to add a GET API integration notes section clarifying that the barcode refresh flow does not use a server-side session cache and that GET /api/get/scan-state returns metadata only while GET /api/get/barcode returns barcode payloads, and note that clients should keep those endpoints separate.

Testing

• Ran workspace type checking with npm run typecheck, which completed successfully.

---

Codex Task

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
slugswap	Ready	Preview, Comment	Mar 16, 2026 2:45am

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 074c5e7c67

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[chatgpt-codex-connector]

Remove nonexistent GET endpoint references

These bullets document GET /api/get/scan-state and GET /api/get/barcode, but the dispatcher in apps/dashboard/app/api/get/[action]/route.ts only implements login-url, link-status, accounts, and link; there are no scan-state or barcode actions. Any client built from this README section will receive 404s for the documented paths, so the new guidance is currently misleading and should be corrected to match the implemented API.

Useful? React with 👍 / 👎.