Contact référentiel

Récupérer les contacts du référentiel

Défini l'entité <RefVisitCard>

Récupération des contacts référentiel

GET https://api.campaign.coefficy.com/v1/refVisitCard

Les contacts sont ordonnés par dernière date de modification descendante et idRefVisitCard

refVisitCard.modified DESC, refVisitCard.idRefVisitCard

Le champ "personaMatchList" contient la liste des persona de votre abonnement qui matchent avec la fonction en question.

Le champ leftCompany dans refVisitCard décrit si le contact est encore considéré comme présent dans l'entreprise. ex: pour un refVisitCard si toutes ses fonctions (functionList) sont en isCurrent à false le leftCompany du refVisitCard sera à true

Query parameters

Name	Type	Description
idCompany	int|int[]
siren	string|string[]
idRefVisitCard	int|int[]
email	string|string[]
linkedinId	string|string[]
leftCompany	bool	true: contacts ayant quitté l'entreprise false: contacts présent dans l'entreprise
onlyCurrentFunctions	bool	Pour ne récupérer que les fonctions actuelles sur toutes les sources
polling	int	Contacts référentiel modifiés durant les x dernières minutes (minimum 15)
limit	int	défaut 100
offset	int	défaut 0

Headers

Name	Type	Description
x-access-token*	String

200: OK

{
    "success": true,
    "code":200,
    "parameters": {
        "idCompany": int|int[]|null,
        "siren": string|string[]|null,
        "idRefVisitCard": int|int[]|null,
        "email": string|string[]|null,
        "linkedinId": string|string[]|null,
        "leftCompany": bool|null,
        "onlyCurrentFunctions": bool|null,
        "polling": int|null,
        "limit": int|null,
        "offset": int|null
    },
    "refVisitCardList": [
        {
            "idRefVisitCard": int,
            "idContact": int,
            "idCompany": int,
            "lastName": string",
            "lastNameNormalized": string,
            "firstName": string,
            "firstNameNormalized": string,
            "fullName": string,
            "email": string|null,
            "phone": string|null,
            "mobile": string|null,
            "leftCompany": bool,
            "isObsolete": bool,
            "linkedinId": string|null,
            "linkedinTechId": string|null,
            "linkedinUrl": string|null,
            "created": datetime,
            "modified": datetime,
            "functionList": [
                {
                    "idRefVisitCardFunction": int,
                    "idRefVisitCard": int,
                    "idRefVisitCardFunctionSource": int,
                    "isCurrent": bool,
                    "isObsolete": bool,
                    "name": string,
                    "startDate": datetime|null,
                    "endDate": datetime|null,
                    "created": datetime,
                    "modified": datetime,
                    "refVisitCardFunctionSource": {
                        "idRefVisitCardFunctionSource": int,
                        "title": string,
                        "frontTitle": string,
                        "created": datetime,
                        "modified": datetime
                    },
                    "personaMatchList": Array<Persona>
                }
            ],
            "company": {
                "idCompany": int,
                "siren": string,
                "name": string,
                "commercialName": string
            }
        }
    ]
}

403

{
    success: false,
    code: 403,
    message: string,
    parameters: {
        "idCompany": int|int[]|null,
        "siren": string|string[]|null,
        "idRefVisitCard": int|int[]|null,
        "email": string|string[]|null,
        "linkedinId": string|string[]|null,
        "polling": int|null,
        "limit": int|null,
        "offset": int|null
    }
}

400

{
    success: false,
    code: 400,
    message: string
    parameters: {
        "idCompany": int|int[]|null,
        "siren": string|string[]|null,
        "idRefVisitCard": int|int[]|null,
        "email": string|string[]|null,
        "linkedinId": string|string[]|null,
        "polling": int|null,
        "limit": int|null,
        "offset": int|null
    }
}