Frappe JS API

This is the source of truth for global Frappe JavaScript APIs. All APIs here are available on every desk page — no import needed.

Full option tables, signatures, and advanced patterns: REFERENCE.md

Use-Case Decision Tree

"I need to call the server"

Is async and you only need r.message?
  YES → frappe.xcall(method, args)   ← returns Promise<value>
  NO  → frappe.call({ method, args, callback, freeze, btn, … })  ← jQuery deferred

"I need to read/write data without opening a form"