Skip to content

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

NomTypeRequisDescription
x-access-tokenStringouiClé API

Paramètres query

NomTypeRequisDescription
idCompanyintconditionnelIdentifiant de la société
idCrmVisitCardintconditionnelIdentifiant du contact CRM
emailStringconditionnelEmail du contact
linkedinStringconditionnelProfil LinkedIn du contact
sirenStringconditionnelNuméro SIREN de la société
leftCompanybooleannontrue = contacts ayant quitté la société, false = contacts en poste
pollingintnonContacts modifiés dans les X dernières minutes (min. 15)

TIP

Au moins un paramètre de filtrage est obligatoire (hors leftCompany et polling).

Réponses

200 — OK
json
{
    "success": true,
    "code": "200",
    "message": "OK",
    "parameters": {
        "idCompany": "int|null",
        "idCrmVisitCard": "int|null"
    },
    "result": {
        "crmVisitCardList": [
            {
                "idCrmVisitCard": "int",
                "idCompany": "int",
                "idUser": "int",
                "idAccount": "int",
                "firstName": "string",
                "lastName": "string",
                "email": "string|null",
                "phone": "string|null",
                "mobile": "string|null",
                "linkedinId": "string|null",
                "linkedinTechId": "string|null",
                "created": "datetime",
                "modified": "datetime",
                "functionList": [
                    {
                        "title": "string",
                        "startDate": "datetime|null",
                        "endDate": "datetime|null",
                        "persona": "object|null"
                    }
                ]
            }
        ]
    }
}
400 — Bad Request
json
{
    "success": false,
    "code": "400",
    "message": "Au moins un paramètre de filtrage est requis"
}
401 — Unauthorized
json
{
    "success": false,
    "code": "401",
    "message": "Clé API invalide"
}
403 — Forbidden
json
{
    "success": false,
    "code": "403",
    "message": "Accès refusé"
}

Coefficy — API externe