Contacts CRM

Permet de récupérer les contacts de votre base CRM.

Récupérer les contacts CRM

GET /v1/crmVisitCard

Retourne la liste des contacts CRM avec leurs fonctions, coordonnées et données LinkedIn.

Headers

Nom	Type	Requis	Description
x-access-token	String	oui	Clé API

Paramètres query

Nom	Type	Requis	Description
idCompany	int|int[]	conditionnel	Identifiant(s) de la société
idCrmVisitCard	int|int[]	conditionnel	Identifiant(s) du contact CRM
email	String|String[]	conditionnel	Email(s) du contact
linkedin	String|String[]	conditionnel	Identifiant(s) LinkedIn du contact
siren	String|String[]	conditionnel	Numéro(s) SIREN de la société
polling	int	conditionnel	Contacts modifiés dans les X dernières minutes (min. 15)
leftCompany	boolean	non	true = contacts ayant quitté la société, false = contacts en poste

TIP

Au moins un paramètre parmi idCompany, siren, idCrmVisitCard, polling, email ou linkedin est obligatoire.

Réponses

200 — OK

{
    "success": true,
    "parameters": {
        "idAccount": "string|null",
        "idCompany": "int[]|null",
        "siren": "string[]|null",
        "idCrmVisitCard": "int[]|null",
        "email": "string[]|null",
        "linkedin": "string[]|null",
        "leftCompany": "boolean|null",
        "polling": "int|null"
    },
    "crmVisitCardList": [
        {
            "idCrmVisitCard": "int",
            "idRefVisitCard": "int|null",
            "idAccount": "string",
            "idUser": "int|null",
            "userLastModified": "datetime|null",
            "idCompany": "int|null",
            "idLebonlogicielVisitCard": "int|null",
            "firstName": "string|null",
            "firstNameNormalized": "string|null",
            "lastName": "string|null",
            "lastNameNormalized": "string|null",
            "fullName": "string|null",
            "email": "string|null",
            "phone": "string|null",
            "mobile": "string|null",
            "linkedinId": "string|null",
            "linkedinTechId": "string|null",
            "linkedinUrl": "string|null",
            "companySiret": "int|null",
            "isCompany": "bool",
            "lastEnrichmentDate": "datetime|null",
            "contactLeftCompany": "bool",
            "contactCreatedByUser": "bool",
            "created": "datetime",
            "modified": "datetime",
            "company": "object|null",
            "functionList": [
                {
                    "idCrmVisitCardFunction": "int",
                    "idCrmVisitCard": "int",
                    "idRefVisitCardFunction": "int|null",
                    "idPersona": "int|null",
                    "isCurrent": "bool|null",
                    "name": "string",
                    "startDate": "date|null",
                    "endDate": "date|null",
                    "created": "datetime",
                    "modified": "datetime",
                    "persona": {
                        "idPersona": "int",
                        "idUser": "int|null",
                        "idAccount": "string|null",
                        "title": "string",
                        "description": "string|null",
                        "isActive": "bool|null",
                        "created": "datetime",
                        "modified": "datetime"
                    }
                }
            ],
            "latestFunction": "object|null"
        }
    ]
}

Notes :

• isCompany indique une fiche "contact société" générique (et non une personne physique).
• contactLeftCompany indique que le contact a quitté la société ; contactCreatedByUser qu'il a été créé manuellement par un utilisateur.
• persona est null si aucune persona n'est associée à la fonction. latestFunction reprend la structure d'un élément de functionList.

400 — Bad Request

{
    "success": false,
    "message": "Paramètre idCompany, siren, idCrmVisitCard, polling, email ou linkedin nécessaire",
    "parameters": {}
}

401 — Unauthorized

{
    "success": false,
    "code": "401",
    "message": "Clé API invalide"
}

403 — Forbidden

{
    "success": false,
    "code": 403,
    "message": "L'abonnement n'a pas accès à ces données",
    "parameters": {}
}