Docage API
French
  • French
  • Spanish
  1. Récupérer un seul objet
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
          GET
        • Récupérer un contact par son email
          GET
        • Récupérer un utilisateur par son email
          GET
      • 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
    • Modifier les champs personnalisés d'une entité
    • Créer une transaction en renseignant ses champs personnalisés
  • 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. Récupérer un seul objet

Récupérer un utilisateur par son email

GET
/DocageUsers/ByEmail/{UserName}
Retourne l'utilisateur qui a l'email spécifié. Si aucun utilisateur ne correspond à cet email, un json vide sera retourné.

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Path Params

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.docage.com/DocageUsers/ByEmail/' \
--header 'Authorization: Basic <encoded-value>'
Response Response Example
{
    "Email": "string",
    "FirstName": "string",
    "LastName": "string",
    "Address1": null,
    "Address2": null,
    "City": null,
    "State": null,
    "ZipCode": null,
    "Country": null,
    "Phone": "string",
    "Mobile": "string",
    "Company": "string",
    "Job": "string",
    "Gender": 0,
    "Civility": "string",
    "Language": 0,
    "EbpUserName": null,
    "AlertEnabled": true,
    "CourrierEnabled": true,
    "GdprEnabled": true,
    "SignatureEnabled": true,
    "ApplicationUserId": "string",
    "ApiKey": "string",
    "SettingsJson": "string",
    "Settings": {
        "Interface": {
            "Transactions": {
                "List": {}
            },
            "Mode": 0
        }
    },
    "Template": null,
    "Instances": null,
    "ApplicationUser": null,
    "BoxDocageUsers": [
        "string"
    ],
    "Boxes": [
        "string"
    ],
    "CircleDocageUsers": [
        "string"
    ],
    "Circles": [
        "string"
    ],
    "FormObservers": [
        "string"
    ],
    "ChildLogs": [
        "string"
    ],
    "ChildOrders": [
        "string"
    ],
    "TransactionMembers": [
        "string"
    ],
    "ChildAccesses": [
        "string"
    ],
    "OrganizationName": "string",
    "IntegratorName": null,
    "IsAdministratorForUI": true,
    "IsCreditsManagerForUI": true,
    "CreditsConsumed": 0,
    "BlockingDate": null,
    "ProfilePictureSmall": "string",
    "ProfilePictureMedium": "string",
    "ProfilePictureLarge": "string",
    "MailboxId": null,
    "UseCustomSmtp": true,
    "Mailbox": null,
    "CreditReportLinesConsumed": [
        "string"
    ],
    "ChildRights": [
        "string"
    ],
    "IdentityRequests": [
        "string"
    ],
    "IdentityId": null,
    "Identity": null,
    "IdentityLevel": 0,
    "IsTemplate": true,
    "TemplateId": null,
    "GeneratedByFormId": null,
    "GeneratedByForm": null,
    "CustomFieldsFromTemplate": [
        {
            "Other": true,
            "Multiple": true,
            "Values": [
                {
                    "Label": "string",
                    "Value": "string",
                    "Selected": true
                }
            ],
            "ConditionalOptions": [
                "string"
            ],
            "MinSelectionAllowed": "string",
            "MaxSelectionAllowed": "string",
            "UserData": [
                "string"
            ],
            "Description": "string",
            "Required": true,
            "CanBeFilledByOneClick": true,
            "TargetValue": null,
            "ConditionalValues": null,
            "CalculatedValue": null,
            "Hidden": true,
            "Readonly": true,
            "Type": "string",
            "Label": "string",
            "ClassName": "string",
            "Name": "string",
            "Access": true,
            "ConditionalDisplay": "string"
        }
    ],
    "CustomFieldsForInstances": [
        {
            "Other": true,
            "Multiple": true,
            "Values": [
                {
                    "Label": "string",
                    "Value": "string",
                    "Selected": true
                }
            ],
            "ConditionalOptions": [
                "string"
            ],
            "MinSelectionAllowed": "string",
            "MaxSelectionAllowed": "string",
            "UserData": [
                "string"
            ],
            "Description": "string",
            "Required": true,
            "CanBeFilledByOneClick": true,
            "TargetValue": null,
            "ConditionalValues": null,
            "CalculatedValue": null,
            "Hidden": true,
            "Readonly": true,
            "Type": "string",
            "Label": "string",
            "ClassName": "string",
            "Name": "string",
            "Access": true,
            "ConditionalDisplay": "string"
        }
    ],
    "ParentRights": [
        "string"
    ],
    "ParentAccesses": [
        "string"
    ],
    "ParentRightsDTO": [
        {
            "SecurityEntityTypeName": "string",
            "SecurityEntityId": "string",
            "SecurityEntityName": "string",
            "RightLevel": 0,
            "EntityTypeName": "string",
            "EntityId": "string",
            "Priority": 0,
            "IsSystem": true
        }
    ],
    "ParentOrganizationId": "string",
    "EntityState": 0,
    "ArchiveStartDate": null,
    "ArchiveEndDate": null,
    "Notes": null,
    "ParentLogs": [
        "string"
    ],
    "CreatorId": null,
    "CreatorName": null,
    "CreatorEmail": null,
    "Webhooks": [
        "string"
    ],
    "DocageLinks": null,
    "ParentOrganization": {
        "Name": "string",
        "Address1": "string",
        "Address2": null,
        "City": "string",
        "State": null,
        "ZipCode": "string",
        "Country": "string",
        "Phone": null,
        "Mobile": null,
        "VatNumber": "string",
        "BIC": null,
        "IBAN": null,
        "SEPANumber": null,
        "Language": 0,
        "IsDemo": true,
        "PartnerId": null,
        "PromoCode": null,
        "OrganizationStatus": 0,
        "OrganizationType": 0,
        "IsDeveloper": true,
        "IntegratorId": "string",
        "ProductionDate": null,
        "HasIntegratorRightForUI": true,
        "CanManageCreditsForUI": true,
        "CanAdminClientsForUI": true,
        "Credits": 0,
        "CreditsAlertLimit": 0,
        "CreditsAutoOrderLimit": 0,
        "CreditsAutoOrderQuantity": 0,
        "ClientPriceForUser": 0,
        "ClientPriceForStorage": 0,
        "ClientPriceForTransaction": 0,
        "ClientPriceForTransactionSignatory": 0,
        "ClientPriceForAdditionalTransactionFile": 0,
        "PriceForUser": 0,
        "PriceForStorage": 0,
        "PriceForTransaction": 0,
        "PriceForTransactionSignatory": 0,
        "PriceForAdditionalTransactionFile": 0,
        "OrderAutoDebitIntegrator": true,
        "ConsumeIntegratorCredits": true,
        "CustomFieldsUserData": null,
        "CustomFieldsForBox": null,
        "CustomFieldsForCircle": null,
        "CustomFieldsForContact": [
            {
                "Subtype": "string",
                "Type": "string",
                "Label": "string",
                "ClassName": "string",
                "Name": "string",
                "Access": true,
                "ConditionalDisplay": null,
                "Other": true,
                "Multiple": true,
                "Values": [
                    {
                        "Label": "string",
                        "Value": "string",
                        "Selected": true
                    }
                ],
                "ConditionalOptions": null,
                "MinSelectionAllowed": "string",
                "MaxSelectionAllowed": "string",
                "UserData": null,
                "Description": "string",
                "Required": true,
                "CanBeFilledByOneClick": true,
                "TargetValue": null,
                "ConditionalValues": null,
                "CalculatedValue": null,
                "Hidden": true,
                "Readonly": true,
                "Inline": true,
                "Toggle": true,
                "Placeholder": null,
                "Min": 0,
                "Max": 0,
                "Step": 0,
                "Value": "string",
                "Maxlength": null,
                "Rows": 0
            }
        ],
        "CustomFieldsForDocageUser": null,
        "CustomFieldsForDocument": null,
        "CustomFieldsForForm": null,
        "CustomFieldsForOrganization": null,
        "CustomFieldsForTransaction": [
            {
                "Subtype": "string",
                "Placeholder": null,
                "Maxlength": null,
                "Value": null,
                "UserData": null,
                "Description": null,
                "Required": true,
                "CanBeFilledByOneClick": true,
                "TargetValue": null,
                "ConditionalValues": null,
                "CalculatedValue": null,
                "Hidden": true,
                "Readonly": true,
                "Type": "string",
                "Label": "string",
                "ClassName": "string",
                "Name": "string",
                "Access": true,
                "ConditionalDisplay": null
            }
        ],
        "TransactionSent": 0,
        "SettingsJson": "string",
        "Settings": {
            "Integrator": {
                "SubscriptionTransactionTemplateId": null
            },
            "Interface": {
                "Transactions": {
                    "List": {}
                },
                "Mode": 0
            }
        },
        "Template": null,
        "Instances": null,
        "ChildOrganization": null,
        "Integrator": null,
        "CircleOrganizations": [
            "string"
        ],
        "ParentCircles": [
            "string"
        ],
        "Boxes": [
            "string"
        ],
        "BoxFiles": [
            "string"
        ],
        "Clients": [
            "string"
        ],
        "Circles": [
            "string"
        ],
        "Contacts": [
            "string"
        ],
        "CreditReports": [
            "string"
        ],
        "CreditReportLines": [
            "string"
        ],
        "DocageUsers": [
            "string"
        ],
        "Documents": [
            "string"
        ],
        "Forms": [
            "string"
        ],
        "IdentityFiles": [
            "string"
        ],
        "IdentityFileProcessingFiles": [
            "string"
        ],
        "Mailboxes": [
            "string"
        ],
        "Transactions": [
            "string"
        ],
        "TransactionMembers": [
            "string"
        ],
        "TransactionFiles": [
            "string"
        ],
        "TransactionMemberSignatureLocations": [
            "string"
        ],
        "Orders": null,
        "ClientOrders": [
            "string"
        ],
        "IntegratorOrders": [
            "string"
        ],
        "IntegratorCreditReports": [
            "string"
        ],
        "ClientCreditReports": [
            "string"
        ],
        "GlobalWebhooks": [
            "string"
        ],
        "CustomFieldsFromOrganization": null,
        "AdministratorsCircle": null,
        "ClientsAdministratorsCircle": null,
        "CreditsManagersCircle": null,
        "CreditsConsumed": 0,
        "BlockingDate": null,
        "ProfilePictureSmall": "string",
        "ProfilePictureMedium": "string",
        "ProfilePictureLarge": "string",
        "MailboxId": "string",
        "UseCustomSmtp": true,
        "Mailbox": null,
        "CreditReportLinesConsumed": [
            "string"
        ],
        "ChildRights": [
            "string"
        ],
        "IdentityRequests": [
            "string"
        ],
        "IdentityId": null,
        "Identity": null,
        "IdentityLevel": 0,
        "IsTemplate": true,
        "TemplateId": null,
        "GeneratedByFormId": null,
        "GeneratedByForm": null,
        "CustomFieldsFromTemplate": null,
        "CustomFieldsForInstances": null,
        "ParentRights": [
            "string"
        ],
        "ParentAccesses": [
            "string"
        ],
        "ParentRightsDTO": [
            "string"
        ],
        "ParentOrganizationId": "string",
        "EntityState": 0,
        "ArchiveStartDate": null,
        "ArchiveEndDate": null,
        "Notes": null,
        "ParentLogs": [
            "string"
        ],
        "CreatorId": "string",
        "CreatorName": "string",
        "CreatorEmail": "string",
        "Webhooks": [
            "string"
        ],
        "DocageLinks": null,
        "ParentOrganization": null,
        "RightLevel": 0,
        "BoxIds": [
            "string"
        ],
        "AddToBoxIds": [
            "string"
        ],
        "RemoveFromBoxIds": [
            "string"
        ],
        "IsArchived": true,
        "ExternalId": null,
        "CustomFields": [
            {
                "Other": true,
                "Multiple": true,
                "Values": [
                    {
                        "Label": "string",
                        "Value": "string",
                        "Selected": true
                    }
                ],
                "ConditionalOptions": null,
                "MinSelectionAllowed": "string",
                "MaxSelectionAllowed": "string",
                "UserData": null,
                "Description": null,
                "Required": true,
                "CanBeFilledByOneClick": true,
                "TargetValue": null,
                "ConditionalValues": null,
                "CalculatedValue": null,
                "Hidden": true,
                "Readonly": true,
                "Type": "string",
                "Label": "string",
                "ClassName": "string",
                "Name": "string",
                "Access": true,
                "ConditionalDisplay": null,
                "Subtype": "string",
                "Placeholder": null,
                "Maxlength": null,
                "Value": null
            }
        ],
        "Creator": null,
        "Id": "string",
        "CreationDate": "string",
        "ModificationDate": "string"
    },
    "RightLevel": 0,
    "BoxIds": [
        "string"
    ],
    "AddToBoxIds": [
        "string"
    ],
    "RemoveFromBoxIds": [
        "string"
    ],
    "IsArchived": true,
    "ExternalId": null,
    "CustomFieldsFromOrganization": [
        {
            "Other": true,
            "Multiple": true,
            "Values": [
                {
                    "Label": "string",
                    "Value": "string",
                    "Selected": true
                }
            ],
            "ConditionalOptions": [
                "string"
            ],
            "MinSelectionAllowed": "string",
            "MaxSelectionAllowed": "string",
            "UserData": [
                "string"
            ],
            "Description": "string",
            "Required": true,
            "CanBeFilledByOneClick": true,
            "TargetValue": null,
            "ConditionalValues": null,
            "CalculatedValue": null,
            "Hidden": true,
            "Readonly": true,
            "Type": "string",
            "Label": "string",
            "ClassName": "string",
            "Name": "string",
            "Access": true,
            "ConditionalDisplay": "string"
        }
    ],
    "CustomFields": [
        {
            "Other": true,
            "Multiple": true,
            "Values": [
                {
                    "Label": "string",
                    "Value": "string",
                    "Selected": true
                }
            ],
            "ConditionalOptions": [
                "string"
            ],
            "MinSelectionAllowed": "string",
            "MaxSelectionAllowed": "string",
            "UserData": [
                "string"
            ],
            "Description": "string",
            "Required": true,
            "CanBeFilledByOneClick": true,
            "TargetValue": null,
            "ConditionalValues": null,
            "CalculatedValue": null,
            "Hidden": true,
            "Readonly": true,
            "Type": "string",
            "Label": "string",
            "ClassName": "string",
            "Name": "string",
            "Access": true,
            "ConditionalDisplay": "string"
        }
    ],
    "CustomFieldsUserData": [
        {
            "Name": "string",
            "UserData": [
                "string"
            ],
            "Type": true
        }
    ],
    "Creator": null,
    "Id": "string",
    "CreationDate": "string",
    "ModificationDate": "string",
    "Name": "string"
}
Modified at 2025-10-24 15:23:42
Previous
Récupérer un contact par son email
Next
Récupérer une liste filtrée
Built with