Frappe

Frappe Method API

The Method API from Frappe — 4 operation(s) for method.

Documentation GitHub OpenAPI

Operations 5

GET /api/method/frappe.auth.get_logged_user Get currently logged-in user #

POST /api/method/upload_file Upload a file #

GET /api/method/{dotted_path} Call a whitelisted Python method (read-only) #

POST /api/method/{dotted_path} Call a whitelisted Python method (state-changing) #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/frappe:frappe-method-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Frappe Framework REST Method API
  description: Auto-generated REST API exposing every Frappe DocType for CRUD, filtered list queries, and whitelisted Python method calls.
  version: 1.0.0
servers:
- url: https://{site}
  description: Frappe site base URL
  variables:
    site:
      default: example.frappe.cloud
      description: Frappe site hostname
security:
- apiKey: []
tags:
- name: Method
paths:
  /api/method/login:
    post:
      summary: Login with username and password
      operationId: login
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Login response
          content:
            application/json:
              schema:
                type: object
      tags:
      - Method
  /api/method/frappe.auth.get_logged_user:
    get:
      summary: Get currently logged-in user
      operationId: getLoggedUser
      responses:
        '200':
          description: Logged user response
          content:
            application/json:
              schema:
                type: object
      tags:
      - Method
  /api/method/upload_file:
    post:
      summary: Upload a file
      operationId: uploadFile
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
      responses:
        '200':
          description: Upload response
          content:
            application/json:
              schema:
                type: object
      tags:
      - Method
  /api/method/{dotted_path}:
    get:
      summary: Call a whitelisted Python method (read-only)
      operationId: callMethodGet
      parameters:
      - name: dotted_path
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Method response
          content:
            application/json:
              schema:
                type: object
      tags:
      - Method
    post:
      summary: Call a whitelisted Python method (state-changing)
      operationId: callMethodPost
      parameters:
      - name: dotted_path
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Method response
          content:
            application/json:
              schema:
                type: object
      tags:
      - Method
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: token <api_key>:<api_secret>
x-generated-from: https://docs.frappe.io/framework/user/en/api/rest
x-generated-by: claude-crawl-2026-05-08