frappe-api-handler

Name: frappe-api-handler
Availability: InStock
Author: Venkatesh

Create custom REST API endpoints with permission checks for Frappe applications.

25|14|Updated Dec 15, 2025

Search Tags:#API #authentication #integration #REST #webhook #frappe #ERPNext

Ready to run

npx skills add https://github.com/Venkateshvenki404224/frappe-apps-manager --skill frappe-api-handler

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: frappe-api-handler
Source: https://github.com/Venkateshvenki404224/frappe-apps-manager/tree/main/frappe-apps-manager/skills/frappe-api-handler
Command: npx skills add https://github.com/Venkateshvenki404224/frappe-apps-manager --skill frappe-api-handler

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creating secure and robust custom API endpoints in Frappe for external integrations can be complex, involving careful handling of authentication, validation, and error responses. This Skill streamlines the entire API development process.

Core Features & Use Cases

Whitelisted Methods: Generate Python methods accessible via Frappe's API, complete with built-in permission checks.
REST API Patterns: Create handlers for common HTTP methods (GET, POST, PUT, DELETE), including patterns for pagination and bulk operations.
Secure Endpoints: Implement best practices for authentication (API Key, Token), input validation, and graceful error handling.
Use Case: Quickly generate an API endpoint to allow a mobile application to fetch customer details or create new sales orders directly within Frappe.

Quick Start

Create a Frappe API endpoint to get a list of 'Item' documents, filtered by 'item_group' and paginated.

Frequently Asked Questions about frappe-api-handler

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I create custom API endpoints in Frappe for external integrations?▼

Create custom API endpoints in Frappe by building whitelisted Python methods with built-in permission checks, input validation, and error handling. This Skill provides patterns for REST handlers (GET, POST, PUT, DELETE), authentication (API Key, Token), and secure external system integration.

What's the best way to handle authentication and permissions in Frappe APIs?▼

Implement authentication using API Key or Token-based methods with permission checks enforced at the endpoint level. This Skill covers secure access control patterns, role-based validation, and graceful error reporting to ensure only authorized requests reach your business logic.

Can I build REST endpoints with pagination and bulk operations in Frappe?▼

Yes. This Skill provides REST API patterns for common HTTP methods including pagination handlers and bulk operation patterns, enabling you to fetch filtered document lists (e.g., Items by item_group) with structured response formats and offset-based navigation.

How do I validate inputs and handle errors safely in Frappe API endpoints?▼

Validate inputs and structure error responses using validation patterns provided for input parsing and safe error handling. This Skill ensures robust error reporting, prevents malformed data from reaching your database, and returns consistent error messages to API consumers.

Does Frappe support file uploads through custom API endpoints?▼

Yes. This Skill covers file upload handling patterns for custom API endpoints, enabling you to receive and process files (documents, attachments) directly through REST methods with appropriate validation and storage integration.