Liste des lots

Récupérer la liste des lots

Utilisez la query unitsV2 pour lister les lots (unités locatives) de votre espace client. Elle retourne un objet de type PaginatedUnitsV2 avec data (liste d’objets UnitV2) et meta (totalCount, pagination). Les arguments filters (FilterOption), page, pageSize et sorts permettent de filtrer et paginer les résultats.

Chaque élément de data expose les propriétés du lot : identifiant, état, adresse, description, pièces, équipements, meublé ou non, dates, etc. Consultez le type UnitV2 pour la liste complète des champs disponibles.

query {
  unitsV2(
      filters: []
  ) {
      data {
          id
          state
          address
          description
          comment
          rooms
          equipments
          isFurnished
          archived
          archivedDate
          createdDate
          businessUnit
          organizationId
      }
      meta {
          totalCount
      }
  }
}

État non filtrable

À ce jour, il n'est pas possible de filtrer sur l’état directement dans l’appel, celui-ci étant un champ calculé. Récupérez la liste pour une organisation puis filtrez ou triez côté client si besoin.