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

# Lire un immeuble

> Les informations déclarées de la fiche, par identifiant d’attribut, et son lien.

### Endpoint & Authentification

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

**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 path="id" type="string" required>
  L’identifiant de l’objet.
</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="type" type="string">
  Le type de l’objet, au singulier.
</ResponseField>

<ResponseField name="id" type="string">
  L’identifiant Arquos.
</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>

<ResponseField name="fields" type="object">
  Les informations de la fiche, par identifiant d’attribut. Toutes sont présentes ; une information non renseignée vaut `null`.

  <Expandable title="Ses champs">
    <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="type" type="string">
      Type. Valeurs possibles : `residentiel` (Résidentiel), `tertiaire` (Tertiaire), `hotel` (Hôtel), `hopital` (Hôpital), `autre` (Autre). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="typeOther" type="string">
      Type, précisé. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="ownerType" type="string">
      Type de propriétaire. Valeurs possibles : `sdc` (Syndicat de copropriété), `autre` (Autre). Peut valoir `null`.
    </ResponseField>

    <ResponseField name="accessCode" type="string">
      Code d'accès. Un texte. Peut valoir `null`.
    </ResponseField>

    <ResponseField name="keySafeType" type="string">
      Type de coffre à clé. Un texte. Peut valoir `null`.
    </ResponseField>

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

    <ResponseField name="contract" type="string">
      Contrat de maintenance. Valeurs possibles : `parc` (Au contrat), `hors_parc` (Hors parc). Peut valoir `null`.
    </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/ID_DE_L_OBJET \
  --header 'Authorization: Bearer arq_agent_VOTRE_JETON'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={"system"}
  {
  "type": "immeuble",
  "id": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
  "link": "/equipment/3f1c…",
  "url": "https://app.arquos.eu/url",
  "fields": {
    "name": "texte",
    "address": "texte",
    "type": "texte",
    "typeOther": "texte",
    "ownerType": "texte",
    "accessCode": "texte",
    "keySafeType": "texte",
    "accessOther": "texte",
    "contract": "texte"
  }
  }
  ```
</ResponseExample>


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