Endpoint & Authentification
| Méthode | URL |
|---|
GET | https://app.arquos.eu/api/1.1/wf/get_client |
Authorization: Bearer [VOTRE_API_KEY]
Paramètres de la requête (URL)
Identifiant unique de l’agence.
Requis si client_id est vide.
Recherche par nom ou raison sociale (partiel ou complet).
Requis si nom est vide.
Identifiant unique du client pour une récupération précise.
Réponse
L’API retourne un tableau contenant les fiches clients correspondantes.
Identifiant unique de l’agence.
Identifiant unique du client.
Raison sociale ou nom du client.
Valeurs possibles : Prospect, Client.
Liste de catégories. Valeurs : Propriétaire/exploitant, Gestionnaire.
Email principal de l’entreprise.
Numéro SIREN (9 chiffres).
Numéro SIRET (14 chiffres).
Indique si la fiche est archivée (true) ou active (false).
Liste des contacts rattachés au client.
Ligne directe ou mobile du contact.
Ex: Gardien(ne), Référent sur site.
{
"query_parameters": {
"agency_id": "test_agency_01",
"nom": "ImmoGestion"
}
}
{
"status": "success",
"response": [
{
"client_id": "CLI-882",
"nom": "ImmoGestion Sud",
"email": "sud@immogestion.fr",
"telephone": "0491002233",
"adresse": "45 Avenue du Prado, 13008 Marseille",
"statut": "Client",
"type": ["Gestionnaire"],
"contact": []
},
{
"client_id": "CLI-994",
"nom": "ImmoGestion Nord",
"email": "nord@immogestion.fr",
"telephone": "0320556677",
"adresse": "12 Rue de la Liberté, 59000 Lille",
"statut": "Client",
"type": ["Gestionnaire"],
"contact": [
{
"nom": "Marie Dupont",
"email": "m.dupont@immogestion.fr",
"fonction": "Référent sur site"
},
{
"nom": "Martin Durand",
"email": "m.durand@immogestion.fr",
"fonction": "Gardien"
}
]
}
]
}
