Docage API
French
  • French
  • Spanish
  1. Requêtes communes
Docage API
French
  • French
  • Spanish
  • Requêtes communes
    • Créer un objet
      • Créer un objet
    • Modifier un objet
      • Modifier un objet
    • Suppression des objets
      • Supprimer un objet
      • Supprimer plusieurs objets
    • Récupération des objets
      • Récupérer tous les objets
        • Récupérer une liste d'objets
          • Récupérer tous les contacts
          • Récupérer tous les parcours
          • Récupérer tous les classeurs
        • Récupérer les modèles de parcours
        • Requêter certaines propriétés uniquement
      • Récupérer un seul objet
        • Récupérer un objet par son Id
        • Récupérer un contact par son email
        • Récupérer un utilisateur par son email
      • Récupérer une liste filtrée
        • Filtrer les transactions en cours
        • Filtrer les transactions supérieure à une date
        • Filtrer les transactions signées ET dont le nom contient "Facture"
        • Filtrer les contacts qui s'appellent Léo ou Paul ET dont l'email se termine par gmail.com
        • Filtrer les contacts en fonction des champs personnalisés
      • Récupérer les objets d'un classeur
        • Récupérer les contacts d'un classeur
      • Récupérer une liste triée
        • Trier les contacts par leur prénom
        • Trier les contacts par leur prénom en ordre décroissant
        • Trier les contacts par leur prénom, puis par leur nom en ordre décroissant
      • Récupérer une liste paginée
        • Trier les contacts par leur prénom
        • Trier les contacts par leur prénom en ordre décroissant
        • Trier les contacts par leur prénom, puis par leur nom en ordre décroissant
  • Docage Sign
    • Créer un parcours en une requête
      • Sans modèle de parcours
        • Avec contact existant
        • Avec création d'un contact
        • Avec plusieurs signatures pour un contact
        • Avec modification d'un contact existant
        • Créer un brouillon (sans lancement)
        • Avec fourniture des Ids par le développeur
      • Avec un modèle de parcours
        • Sans modification
          • Sans modification
        • Remplacement d'un membre
          • Par un contact existant
          • Par un nouveau contact
        • Remplacement d'un document
          • Avec un nouveau fichier
          • Avec un modèle de document Docage
        • Ajout d'un membre (à venir)
          • Avec un nouveau contact (à venir)
          • Avec un contact existant (à venir)
        • Ajout d'un document (à venir)
          • Avec un nouveau fichier (à venir)
        • Autres exemples
          • Créer un brouillon (sans lancement)
          • Avec modification des propriétés héritées du modèle
          • Avec modification du mode de signature
    • Création pas à pas
      • Créer une transaction
      • Ajouter un document à la transaction
      • Ajouter un membre à la transaction
      • Ajouter une signature visuelle
      • Lancer une transaction
    • Téléchargement des documents
      • Télécharger un document précis d'une transaction
      • Télécharger tous les documents d'une transaction
      • Télécharger le fichier de preuve
      • Télécharger tous les documents et le fichier de preuve d'une transaction
    • Signer plusieurs transactions en une fois
      • Vérifier la signabilité des transactions
      • Envoyer un code de signature pour signer plusieurs transactions en une fois
      • Signer plusieurs transactions avec un code unique
    • Autres requêtes pour les transactions
      • Récupérer le statut d'une transaction
      • Annuler une transaction
      • Envoyer un rappel
      • Supprimer un/des membres d'une/plusieurs transactions
      • Supprimer un/des fichiers d'une/plusieurs transactions
    • Gestion des signatures visuelles
  • Docage Mail
  • Webhook
    • Etre notifié lorsqu'un objet change d'état
      • Etre notifié lorsqu'une Transaction est supprimée
      • Etre notifié lorsqu'un Utilisateur est bloqué
      • Etre notifié lorsqu'un Utilisateur est débloqué
    • Etre notifié lorsqu'un objet est modifié
      POST
    • Etre notifié lorsqu'une Transaction change de statut
      POST
    • Etre notifié lorsque le contenu d'un classeur est modifié
      POST
    • Etre notifié lorsqu'un formulaire Web est rempli
      POST
    • Etre notifié de l'état de Docage
      POST
    • Supprimer un Webhook par son Id
      DELETE
    • Supprimer plusieurs Webhooks par leur Url
      DELETE
    • Créer un Webhook
      POST
  • Redirections
  • Marque blanche
  • Champs personnalisés
    • Créer une entité avec ses champs personnalisés
      POST
    • Modifier les champs personnalisés d'une entité
      PUT
    • Créer une transaction en renseignant ses champs personnalisés
      POST
  • Organisations
    • Créer une organisation cliente
    • Créer un utilsateur
  • Classeurs
    • Requêtes spécifiques aux classeurs
      • Ajouter des entités à un classeur
      • Supprimer des entités d'un classeur
      • Suppression d'un/plusieurs classeurs avec leur contenu
    • Récupérer les objets d'un classeur
      • Récupérer les transactions d'un classeur
    • Liaisons lors de la création d'un objet
      • Ajouter un objet à un ou plusieurs classeurs à la création
    • Modification des liaisons lors de la modification d'un objet
      • Ajouter un objet à un ou plusieurs classeurs à la modification
      • Supprimer un objet d'un ou plusieurs classeurs à la modification
    • Modification des liaisons entre un objet et les classeurs
      • Ajouter un objet à un/des classeurs
      • Supprimer un objet d'un ou plusieurs classeurs
    • Créer un classeur
    • Modifier un classeur
    • Supprimer un classeur
    • Supprimer plusieurs classeurs
  • Etat des services Docage
  • Créer un Webhook
    POST
  1. Requêtes communes

Récupération des objets

La récupération de liste est une tâche courante mais néanmoins délicate dès lors que l'on veut réaliser un filtrage, un tri, une limitation des propriétés ou encore de la pagination. Nous avons réunis tous ces critères dans un seul objet ListParameter qu'il vous suffit d'envoyer dans le corps de votre requête.
Les propriétés de ListParameter sont les suivantes :
PropriétéUsage
BoxIdFiltrer la liste pour ne récupèrer que les objets d'un classeur
CircleIdRécupére les objets auxquels un cercle a accès
EntityPropertiesListes des propriétés qui seront requêtées, permet d'accèlerer les requêtes.
FilterDéfini un filtre suivant les propriétés et les opérandes spécifiées.
FormTypeFiltre le type de formulaires à retourner
IsTemplateFiltrer la liste pour ne récupèrer que les modèles
SkipPagination : passe les n premiers éléments d'une liste
SortOrderTri la liste dans l'ordre des propriétés définies
TakePagination : Renvoie les n éléments d'une liste après la valeur Skip
TemplateIdRécupère les instances d'un modèle (objets générés à partir d'un modèle précis)
Toutes ces propriétés sont détaillées dans les exemples ci dessous.
Modified at 2025-10-24 06:21:01
Previous
Supprimer plusieurs objets
Next
Récupérer tous les objets
Built with