REST API Guide

Authentication, endpoints, pagination, and interacting with the REST API.

Working with the REST API

Every DocType in the system automatically exposes a standard REST API.

Authentication

Authenticate via API Keys generated in user profiles:

Authorization: token api_key:api_secret

Common Endpoints

• Get Records: GET /api/resource/Customer?fields=["name","customer_name"]
• Get Single: GET /api/resource/Customer/{id}
• Create: POST /api/resource/Customer with JSON body
• Update: PUT /api/resource/Customer/{id}
• Delete: DELETE /api/resource/Customer/{id}