Adlead - Documentation

# Contacts

# Rechercher des contacts

Permet de vérifier l'existence de contacts sur un programme.

UTILE

Il est possible d'effectuer la recherche sur plusieurs adresses e-mails, téléphone ou noms de famille.

Tous les contacts correspondant au minimum avec l'un des éléments de recherche seront renvoyés.

# Requête HTTP

GET https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/contacts?emails[]={email1}&emails[]={email2}&phones[]={phone1}&names[]={name1}

# Paramètres d'URL

Nom de la clé Description
{tenantKey} Clé de l'espace client - Détails
{programId} ID du programme

# Paramètres de requête

Nom du paramètre Description Exemple Format des données
emails[] Adresse(s) e-mails recherchées jean.dupont@gmail.com
phones[] Téléphone(s) recherchés 33600000000 0600000000 Format international ou français
names[] Nom(s) recherchés Dupont

# Exemple de requête HTTP

IMPORTANT

Si vous souhaitez effectuer une recherche sur plusieurs adresses e-mail, téléphones ou noms de famille, veillez à préciser autant de paramètres emails[], phones[] ou names[] que nécessaire.

# Effectuer une recherche avec une seule adresse e-mail

GET https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/contacts?emails[]=adresse1@domaine.fr

# Effectuer une recherche avec plusieurs adresses e-mail

GET https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/contacts?emails[]=adresse1@domaine.fr&emails[]=adresse2@domaine.fr

# Effectuer une recherche avec plusieurs adresses e-mail, téléphones ou noms de famille

GET https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/contacts?emails[]=adresse1@domaine.fr&emails[]=adresse2@domaine.fr&phones[]=0666666666&phones[]=0777777777&names[]=Dupont

# curl

curl --location --request GET 'https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/contacts?emails[]=adresse1@domaine.fr&phones[]=0666666666&names[]=Dupont' \
    --header 'Accept: application/json' \
    --header 'X-API-Key: VOTRE_CLE_API' \

# Body de réponse

DETAILS 
{
    "success": true,
    "message": null,
    "data": [
        {
            "id": 277,
            "lead_id": 246,
            "name": "Delannoy",
            "firstname": "Roland",
            "display_name": "Roland Delannoy",
            "email1": "adresse1@domaine.fr",
            "email2": null,
            "phone1": "+33600000000",
            "phone2": null,
            "legal_entity": false,
            "company_name": null,
            "legal_status": null,
            "city": "Dias",
            "zipcode": "92200",
            "created_at": "2021-01-25T15:44:30.000000Z",
            "updated_at": "2022-02-24T16:54:28.000000Z",
            "last_interaction_at": "2022-02-24T16:54:28.000000Z"
        },
        {
            "id": 15723,
            "lead_id": 14327,
            "name": "Gomez",
            "firstname": "Hervé",
            "display_name": "Hervé Gomez",
            "email1": "h.gomez@domaine.fr",
            "email2": null,
            "phone1": "+33666666666",
            "phone2": null,
            "legal_entity": false,
            "company_name": null,
            "legal_status": null,
            "city": null,
            "zipcode": null,
            "created_at": "2021-11-05T10:55:28.000000Z",
            "updated_at": "2021-11-05T10:55:28.000000Z",
            "last_interaction_at": "2021-11-05T10:55:28.000000Z",
        },
        {
            "id": 16821,
            "lead_id": 14329,
            "name": "Dupont",
            "firstname": "Jean",
            "display_name": "Jean Dupont",
            "email1": null,
            "email2": null,
            "phone1": "+33766666666",
            "phone2": null,
            "legal_entity": false,
            "company_name": null,
            "legal_status": null,
            "city": null,
            "zipcode": null,
            "created_at": "2021-11-05T10:55:28.000000Z",
            "updated_at": "2021-11-05T10:55:28.000000Z",
            "last_interaction_at": "2021-11-05T10:55:28.000000Z",
        }
    ]
}

# Modèle

Champ Type Description Exemple Format des données
id int ID du contact 1854
lead_id int ID du lead associé 1523
name string Nom Dupont
firstname string Prénom Jean
display_name string Prénom Nom ou Raison sociale Jean Dupont Nom société SCI
email1 string Adresse e-mail jean.dupont@gmail.com
email2 string Adresse e-mail secondaire jean.dupont@gmail.com
phone1 string Téléphone 33600000000 0600000000 Format international ou français
phone2 string Téléphone secondaire 33600000000 0600000000 Format international ou français
legal_entity boolean Personne morale true false true = personne morale
legal_status string Statut juridique sci sarl sas Accéder au tableau
company_name string Nom de la société Nom société
city string Ville Paris
zipcode string Code postal 75001
created_at string Date de création 2020-09-04T10:20:04.000000Z ISO 8601
updated_at string Dernière mise à jour 2020-09-04T10:20:04.000000Z ISO 8601
last_interaction_at string Dernière interaction commerciale 2020-09-04T10:20:04.000000Z ISO 8601

← Dénonciations →