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

# Lister les immeubles

> Les immeubles de vos agences, cherchés sur nom, adresse. Chaque ligne porte son lien.

### Endpoint & Authentification

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

**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">
  Ce qu’on cherche (nom, adresse).
</ParamField>

<ParamField query="limit" type="integer">
  Combien de lignes, 50 par défaut, 200 au plus.
</ParamField>

<ParamField query="page" type="integer">
  La page, à partir de 1.
</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`)

<ResponseField name="total" type="integer">
  Le nombre de lignes qui répondent, toutes pages confondues.
</ResponseField>

<ResponseField name="page" type="integer">
  La page rendue, à partir de 1.
</ResponseField>

<ResponseField name="limit" type="integer">
  Le nombre de lignes par page (50 par défaut, 200 au plus).
</ResponseField>

<ResponseField name="results" type="object[]">
  Les lignes de la page.

  <Expandable title="Chaque élément">
    <ResponseField name="id" type="string">
      L’identifiant Arquos.
    </ResponseField>

    <ResponseField name="name" type="string">
      Nom. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="address" type="string">
      Adresse. Un texte. 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>
  </Expandable>
</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/buildings \
  --header 'Authorization: Bearer arq_agent_VOTRE_JETON'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={"system"}
  {
  "total": 1,
  "page": 1,
  "limit": 1,
  "results": [
    {
      "id": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
      "name": "texte",
      "address": "texte",
      "link": "/equipment/3f1c…",
      "url": "https://app.arquos.eu/url"
    }
  ]
  }
  ```
</ResponseExample>


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