> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arquos.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtenir des données clients

> Rechercher et récupérer les fiches complètes d'un ou plusieurs clients.

### Endpoint & Authentification

| Méthode | URL                                           |
| :------ | :-------------------------------------------- |
| `POST`  | `https://app.arquos.eu/api/1.1/wf/get_client` |

**En-têtes (Headers) :**

* `x-api-key: [VOTRE_API_KEY]`

<Note>
  La clé API est propre à chaque partenaire et n'est autorisée que sur les agences qui lui ont été attribuées. Un appel avec une clé invalide, ou visant une agence non autorisée, n'est pas exécuté.
</Note>

### Paramètres de la requête (Body)

<ParamField body="agency_id" type="string" required>
  Identifiant unique de l'agence.
</ParamField>

<ParamField body="nom" type="string">
  Requis si `client_id` est vide.<br />Recherche par nom ou raison sociale (partiel ou complet).
</ParamField>

<ParamField body="client_id" type="string">
  Requis si `nom` est vide.<br />Identifiant unique du client pour une récupération précise.
</ParamField>

### Réponse

L'API retourne un tableau contenant les fiches clients correspondantes.

<Expandable title="Données clients" defaultOpen="true">
  <ResponseField name="client_id" type="string">
    Identifiant unique du client.
  </ResponseField>

  <ResponseField name="nom" type="string">
    Raison sociale ou nom du client.
  </ResponseField>

  <ResponseField name="statut" type="string">
    Valeurs possibles : `Prospect`, `Client`.
  </ResponseField>

  <ResponseField name="type" type="array">
    Liste de catégories. Valeurs : `Propriétaire/exploitant`, `Gestionnaire`.
  </ResponseField>

  <ResponseField name="email" type="string">
    Email principal de l'entreprise.
  </ResponseField>

  <ResponseField name="telephone" type="string">
    Standard téléphonique.
  </ResponseField>

  <ResponseField name="adresse" type="string">
    Adresse du siège social.
  </ResponseField>

  <ResponseField name="complement_adresse" type="string">
    Bâtiment, CS, etc.
  </ResponseField>

  <ResponseField name="siren" type="string">
    Numéro SIREN (9 chiffres).
  </ResponseField>

  <ResponseField name="siret" type="string">
    Numéro SIRET (14 chiffres).
  </ResponseField>

  <ResponseField name="supprime" type="boolean">
    Indique si la fiche est archivée (`true`) ou active (`false`).
  </ResponseField>

  <ResponseField name="contact" type="object[]">
    Liste des contacts rattachés au client.

    <Expandable title="Détails du contact">
      <ResponseField name="nom" type="string">
        Nom complet du contact.
      </ResponseField>

      <ResponseField name="email" type="string">
        Email du contact.
      </ResponseField>

      <ResponseField name="telephone" type="string">
        Ligne directe ou mobile du contact.
      </ResponseField>

      <ResponseField name="fonction" type="string">
        Ex : Gardien(ne), Référent sur site.
      </ResponseField>
    </Expandable>
  </ResponseField>
</Expandable>

<RequestExample>
  ```json JSON theme={null}
  {
    "agency_id": "test_agency_01",
    "nom": "ImmoGestion"
  }
  ```

  ```bash cURL theme={null}
  curl --request POST \
    --url https://app.arquos.eu/api/1.1/wf/get_client \
    --header 'x-api-key: VOTRE_API_KEY' \
    --header 'Content-Type: application/json' \
    --data '{
    "agency_id": "test_agency_01",
    "nom": "ImmoGestion"
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "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"
          }
        ]
      }
    ]
  }
  ```
</ResponseExample>