Lister les documents

Une requête GET sur /api/resource/{doctype} renvoie les documents par pages. Par défaut, seul le nom est inclus.

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

À quoi sert la liste

Pour lister des documents, envoyez un GET vers /api/resource/{doctype}. Exemple : GET /api/resource/Person.

Toutes les listes sont paginées par 20 éléments. limit_page_length change la taille de page. limit_start demande les pages suivantes. La réponse est un objet JSON. La liste est un tableau sous la clé data.

Par défaut, chaque élément ne contient que name :

json

{
  "data": [
    { "name": "000000012" },
    { "name": "000000008" }
  ]
}

Champs supplémentaires

Le paramètre fields est un tableau JSON de noms de champs.

GET /api/resource/Person/?fields=["name","first_name"] renvoie first_name et name pour chaque personne.

Filtres

Le paramètre filters est un tableau JSON d’une ou plusieurs conditions SQL. Chaque condition a la forme [{doctype}, {field}, {operator}, {operand}].

Les personnes dont le prénom est Jane :

GET /api/resource/Person?filters=[["Person","first_name","=","Jane"]]

La réponse de l’exemple ne contient que { "name": "000000012" }.

Point d’attention

Sans fields, seul name est renvoyé, même si le filtre porte sur un autre champ. L’authentification de ces appels est décrite dans Authentification simple et Authentification par jeton (token).