> ## 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.

# Chercher dans Arquos

> La recherche globale de l’écran : équipements, immeubles, clients, affaires, relevés, contrats, appels, écarts, notes.

### Endpoint & Authentification

| Méthode | URL |
| :- | :- |
| `GET` | `https://api.arquos.eu/api/v2/search` |

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

* `Authorization: Bearer [VOTRE_JETON_D_API]`
* `X-Arquos-Agency: [IDENTIFIANT_D_AGENCE]` (facultatif, voir [Agence](/v2/agence))

### Paramètres de la requête

<ParamField query="q" type="string" required>
  Deux caractères au moins.
</ParamField>

<ParamField header="X-Arquos-Agency" type="string">
  L’identifiant de l’agence où agir. Absent : l’agence par défaut du compte. Une agence hors de sa portée est refusée (403).
</ParamField>

### Réponse (`200`)

Les objets de vos agences qui répondent au terme, les plus pertinents d’abord.

<ResponseField name="object" type="string">
  La clé du type d’objet, à passer aux routes génériques (`equipment`, `buildings`, `clients`, `deals`…).
</ResponseField>

<ResponseField name="type" type="string">
  Le type d’objet, au singulier, tel qu’il se lit (« Équipement », « Client »).
</ResponseField>

<ResponseField name="id" type="string">
  L’identifiant Arquos.
</ResponseField>

<ResponseField name="name" type="string">
  Ce qui nomme l’objet (numéro, nom, adresse). Peut valoir `null`.
</ResponseField>

<ResponseField name="detail" type="string">
  Une précision : l’immeuble d’un équipement, la ville d’un client… Peut valoir `null`.
</ResponseField>

<ResponseField name="via" type="string">
  Quand l’objet a été trouvé par un autre (le client d’un immeuble cherché), ce qui l’a fait trouver. Peut valoir `null`.
</ResponseField>

<ResponseField name="link" type="string">
  Le chemin de la fiche dans Arquos.
</ResponseField>

<ResponseField name="url" type="string">
  L’adresse complète de la fiche, à ouvrir dans un navigateur.
</ResponseField>

### Les erreurs

| Code | Quand |
| :- | :- |
| `400` | Requête mal formée ou champ obligatoire manquant. |
| `401` | Jeton absent, inconnu ou révoqué. |
| `403` | Agence hors de votre portée. |
| `404` | Objet introuvable dans vos agences. |
| `429` | Trop d’appels : réessayez après le délai de l’en-tête Retry-After. |

Le corps d'une erreur porte `error`, sa raison en français. Voir [Les erreurs](/v2/erreurs).

<RequestExample>
  ```bash cURL theme={"system"}
  curl --request GET \
  --url https://api.arquos.eu/api/v2/search \
  --header 'Authorization: Bearer arq_agent_VOTRE_JETON'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={"system"}
  [
  {
    "object": "equipment",
    "type": "Équipement",
    "id": "0b6f0e0c-2c55-4a4c-9a0e-6f0a3b6f2b1d",
    "name": "53 A 00068 01",
    "detail": "Les Jardins Saint-Nicolas",
    "via": null,
    "link": "/equipment/0b6f0e0c-2c55-4a4c-9a0e-6f0a3b6f2b1d",
    "url": "https://app.arquos.eu/equipment/0b6f0e0c-2c55-4a4c-9a0e-6f0a3b6f2b1d"
  }
  ]
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.