Manipuler les documents

Cinq routes couvrent la liste, la création, la lecture, la mise à jour partielle et la suppression. La liste est paginée par 20 et ne renvoie que le nom.

1 min de lectureMis à jour le 5 octobre 2026Source : docs.frappe.io

Vocabulaire

Un DocType est un type de document, par exemple Customer, Employee ou Item. DocumentName est l’identifiant unique, par exemple CUST-00001. Les exemples de cette page n’authentifient pas. Voir Authentification simple et OAuth 2. La vue d’ensemble est dans Introduction à l’API REST.

Lister

GET /api/resource/{DocType}. Par défaut, seul name est renvoyé. fields ajoute des champs, par exemple ["name","country"]. filters est une liste de conditions [DocType, champ, opérateur, valeur]. limit_page_length change la taille de page, 20 par défaut. limit_start demande la page suivante : un multiple de la taille, 20 pour la deuxième page.

Exemple : au plus 20 noms de clients dont le téléphone est 4915227058038. La réponse montrée est { "data": [{ "name": "CUST-00001" }] }.

Créer

POST /api/resource/{DocType}, corps JSON {"fieldname": value}. L’exemple crée un prospect (Lead) avec lead_name Mustermann.

Lire

GET /api/resource/{DocType}/{DocumentName}. Exemple : le client CUST-00001.

Mettre à jour

PUT /api/resource/{DocType}/{DocumentName} se comporte comme un PATCH : on n’envoie que les champs à changer. L’exemple met contact_date au 2018-10-08 sur LEAD-00001. La réponse data reprend le DocType, le nom, la date, et le reste du document abrégé par "...": "...".

Supprimer

DELETE /api/resource/{DocType}/{DocumentName}. La page donne les paramètres de chemin, pas d’exemple de réponse.

Point d’attention

Sans fields, la liste ne contient que le nom, même si le filtre porte sur un autre champ. La deuxième page commence à limit_start 20 seulement si la taille de page est restée à 20.