Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

ERPNext Frappe Cloud (BYOK) — connector documentation

  • MCP endpoint: https://byok-erpnext-frappe-cloud.connectorbay.com/mcp
  • REST API: POST https://byok-erpnext-frappe-cloud.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-erpnext-frappe-cloud.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own ERPNext Frappe Cloud API key and API secret joined by a colon, as api_key:api_secret, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-erpnext-frappe-cloud.connectorbay.com/health · Tool schemas: https://byok-erpnext-frappe-cloud.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-erpnext-frappe-cloud · agent@connectorbay.com

What ERPNext Frappe Cloud (BYOK) is for

ERPNext Frappe Cloud (BYOK) lets an AI assistant read your own ERPNext Frappe Cloud data through the ERPNext Frappe Cloud API with a key you supply (API key and API secret joined by a colon, as api_key:api_secret). Read-only: 6 tools (get_logged_user, list_documents, list_recently_modified, list_documents_with_links, get_document, get_document_with_links). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to *.frappe.cloud. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by ERPNext Frappe Cloud. ERPNext Frappe Cloud and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which ERPNext user does my API key act as?"
  • "List my 20 latest ERPNext Sales Invoices with customer and grand total"
  • "What ERPNext Sales Orders changed most recently?"
  • "List ERPNext Sales Invoices with the customer record expanded"
  • "Show ERPNext Customer CUST-0001"
  • "Show ERPNext Sales Invoice SINV-0001 with customer details expanded"

What it does

  • get_logged_user: Show which user the API key and secret belong to (the email of the user the requests run as).
  • list_documents: List documents of one DocType with the fields you ask for (JSON array), optional filters, sorting and paging. Runs with the roles of the key's user.
  • list_recently_modified: List the most recently modified documents of one DocType (newest first) with name, creation and modification time.
  • list_documents_with_links: List documents of one DocType and expand the named link fields into their linked records (expand takes a JSON array of link field names).
  • get_document: Get one document by DocType and name with all its fields and child tables as the site returns them.
  • get_document_with_links: Get one document with all link fields expanded into their linked records.

BYOK key

You bring your own ERPNext Frappe Cloud API key and API secret joined by a colon, as api_key:api_secret (https://docs.frappe.io/framework/user/en/api/rest). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to *.frappe.cloud over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the ERPNext Frappe Cloud API (*.frappe.cloud) with a BYOK key; documentation: https://docs.frappe.io/framework/user/en/api/rest. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by ERPNext Frappe Cloud. ERPNext Frappe Cloud and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your ERPNext Frappe Cloud account.

Built for: Worldwide. Languages: English.