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

# Récupérer une annonce par id ou référence

> Récupère une annonce (listing publique) par son `id` MongoDB ou sa `reference` métier.

Exactement **un** des deux paramètres `id` / `reference` doit être fourni — pas zéro, pas les deux. L'annonce n'est retournée que si elle appartient à la `agencyGroup` du token ET à une des `agencies` du LinkedAPI ; sinon `ad: null`. Seuls les champs de diffusion publique sont exposés (médias en URLs CloudFront, adresse au niveau rue conditionnée par `location.isLocationDisplayed`). Endpoint en lecture seule.



## OpenAPI

````yaml /openapi.yaml get /external-integration/ad
openapi: 3.1.0
info:
  title: Avest External Integration API
  version: 1.0.0
  description: >-
    API d'intégration externe Avest. Permet de rechercher des contacts et des
    collaborateurs, de récupérer des transactions (ventes, acquisitions,
    locations) et de créer/mettre à jour des transactions avec déduplication
    automatique.


    Tous les endpoints requièrent un token LinkedAPI (scope
    `externalIntegration`) dont la clé doit avoir un `agencyGroup` configuré.
    Les données sont strictement limitées au périmètre autorisé du token :
    aucune fiche hors `agencyGroup` n'est jamais retournée.
servers:
  - url: https://api.avest.fr/v1
    description: API de production Avest
security:
  - linkedApiToken: []
tags:
  - name: Contacts
    description: Recherche et récupération de contacts.
  - name: Users
    description: Récupération des collaborateurs (annuaire).
  - name: Transactions
    description: Récupération et recherche de ventes, acquisitions et locations.
  - name: Lead generation
    description: Création / mise à jour de transactions (ventes, acquisitions, locations).
  - name: Matches
    description: Récupération et recherche de rapprochements (matches vente / acquisition).
  - name: Activities
    description: Récupération et création des activités liées à un document.
  - name: Ads
    description: Récupération et recherche d'annonces (listings publiques).
  - name: Key
    description: Type de la clé API et méthodes qu'elle autorise.
  - name: Agencies
    description: Découverte des agences accessibles par la clé.
  - name: Shift planning
    description: >-
      Planning de permanence d'une agence, semaine par semaine. Écriture
      réservée aux clés autorisées en écriture.
paths:
  /external-integration/ad:
    get:
      tags:
        - Ads
      summary: Récupérer une annonce par id ou référence
      description: >-
        Récupère une annonce (listing publique) par son `id` MongoDB ou sa
        `reference` métier.


        Exactement **un** des deux paramètres `id` / `reference` doit être
        fourni — pas zéro, pas les deux. L'annonce n'est retournée que si elle
        appartient à la `agencyGroup` du token ET à une des `agencies` du
        LinkedAPI ; sinon `ad: null`. Seuls les champs de diffusion publique
        sont exposés (médias en URLs CloudFront, adresse au niveau rue
        conditionnée par `location.isLocationDisplayed`). Endpoint en lecture
        seule.
      operationId: getAd
      parameters:
        - name: id
          in: query
          required: false
          description: >-
            Identifiant Mongo de l'annonce (24 chars hex). Exclusif avec
            `reference`.
          schema:
            $ref: '#/components/schemas/ObjectId'
        - name: reference
          in: query
          required: false
          description: Référence métier de l'annonce. Exclusif avec `id`.
          schema:
            type: string
      responses:
        '200':
          description: Annonce trouvée (ou `null` si hors scope / inexistante).
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAdResponse'
              examples:
                trouve:
                  summary: Annonce trouvée
                  value:
                    success: true
                    ad:
                      id: 6a044cba8db14b3fbd015208
                      reference: REF-2025-001
                      status: online
                      adType: sale
                      adSaleType: old
                      title: Bel appartement 3 pièces
                      description: Lumineux, proche métro
                      propertyType: housing
                      propertyHousingType: apartment
                      surface: 65
                      mandateNumber: '1729'
                      mandateType: exclusive
                      isPriceDisplayed: true
                      salePrice: 252000
                      buyerSaleFee: 0
                      sellerSaleFee: 12000
                      contact:
                        firstName: Marie
                        lastName: Martin
                        email: marie.martin@agence.com
                        phone: '+33601020304'
                      location:
                        number: '3'
                        route: Avenue Reille
                        postalCode: '75014'
                        city: Paris
                        country: France
                        isLocationDisplayed: true
                      pictures:
                        - https://static.example.com/ad/6a044cba8db14b3fbd015208
                      urlAgencyAd: https://agence.example.com/annonce/REF-2025-001
                      transactionType: sale
                      transactionModel: 619b46b47e043165f206db1b
                      transactionStep: MND
                      owner: 6939530d9200187f19a2707d
                      firstPublicationDate: '2026-05-13T10:04:42.139Z'
                      lastPublicationDate: '2026-05-14T10:04:42.139Z'
                      createdAt: '2026-05-13T10:04:42.139Z'
                nonTrouve:
                  summary: Non trouvée ou hors scope
                  value:
                    success: true
                    ad: null
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    ObjectId:
      type: string
      description: Identifiant Mongo (24 caractères hexadécimaux).
      pattern: ^[a-fA-F0-9]{24}$
      example: 618a35a36d932054e195ca0a
    GetAdResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        ad:
          oneOf:
            - $ref: '#/components/schemas/Ad'
            - type: 'null'
    Ad:
      type: object
      description: >-
        Annonce (listing publique). Seuls les champs de diffusion publique sont
        exposés ; les champs non renseignés sont absents.
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        reference:
          type: string
        status:
          $ref: '#/components/schemas/AdStatus'
        adType:
          type: string
        adSaleType:
          type: string
        title:
          type: string
        description:
          type: string
        propertyType:
          type: string
        propertyHousingType:
          type: string
        propertyCommercialType:
          type: string
        surface:
          type: number
        mandateNumber:
          type: string
        mandateType:
          type: string
        isPriceDisplayed:
          type: boolean
        salePrice:
          type: number
        buyerSaleFee:
          type: number
        sellerSaleFee:
          type: number
        rentalNetMonthlyRent:
          type: number
        rentalMonthlyMaintenanceCost:
          type: number
        rentalFee:
          type: number
        rentalDeposit:
          type: number
        contact:
          oneOf:
            - $ref: '#/components/schemas/AdContact'
            - type: 'null'
        location:
          oneOf:
            - $ref: '#/components/schemas/AdLocation'
            - type: 'null'
        pictures:
          type: array
          items:
            type: string
          description: URLs publiques CloudFront.
        urlAgencyAd:
          type: string
        urlVirtualVisit:
          type: string
        urlVideo:
          type: string
        urlOtherMedia:
          type: string
        transactionType:
          type: string
        transactionModel:
          oneOf:
            - $ref: '#/components/schemas/ObjectId'
            - type: 'null'
          description: ObjectId de la transaction liée. `null` si absente.
        transactionStep:
          type: string
        owner:
          oneOf:
            - $ref: '#/components/schemas/ObjectId'
            - type: 'null'
          description: ObjectId de l'utilisateur responsable. `null` si non attribué.
        firstPublicationDate:
          type: string
          format: date-time
        lastPublicationDate:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          const: false
        errorCode:
          type: string
          description: >-
            Code stable, présent sur certaines erreurs seulement (par exemple
            `VISIT_DATE_REQUIRED`, `CONTACT_DELETED`). À préférer à `message`
            pour reconnaître une erreur.
        message:
          type: string
    RateLimitErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          const: false
        message:
          type: string
          example: Rate limit exceeded
        retryAfter:
          type: integer
          description: Secondes avant de pouvoir réessayer.
    AdStatus:
      type: string
      description: Statut de diffusion d'une annonce.
      enum:
        - online
        - offline
        - archived
    AdContact:
      type: object
      description: Contact de diffusion de l'annonce.
      properties:
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        phone:
          type: string
    AdLocation:
      type: object
      description: >-
        Localisation de l'annonce. `number` et `route` ne sont présents que
        lorsque `isLocationDisplayed` vaut `true`.
      properties:
        number:
          type: string
        route:
          type: string
        postalCode:
          type: string
        city:
          type: string
        country:
          type: string
        isLocationDisplayed:
          type: boolean
  headers:
    RateLimit-Limit:
      description: Nombre de requêtes autorisées dans la fenêtre courante.
      schema:
        type: integer
    RateLimit-Remaining:
      description: Requêtes restantes dans la fenêtre courante.
      schema:
        type: integer
    RateLimit-Reset:
      description: Secondes avant la réinitialisation de la fenêtre.
      schema:
        type: integer
    Retry-After:
      description: Secondes à attendre avant de réessayer (présent sur les réponses `429`).
      schema:
        type: integer
  responses:
    BadRequest:
      description: >-
        Requête invalide. Le champ `message` précise la cause (paramètre
        manquant, invalide, mutuellement exclusif, clé de query inconnue,
        `LinkedAPI agencyGroup is required`, etc.).


        Les exemples ci-dessous sont **illustratifs et non exhaustifs** : les
        messages réellement renvoyés dépendent de la route. En particulier, le
        rejet des clés de query inconnues n'est appliqué que par `/contact`,
        `/contacts`, `/user`, `/users` et `/{transaction}/search`.


        La plupart des messages de validation sont préfixés par le contexte qui
        les émet, sous la forme `"<Contexte> : <message>"`. **Ne faites jamais
        de correspondance exacte sur `message`** : basez-vous sur le code HTTP
        et traitez `message` comme du texte destiné au diagnostic.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unParametreRequis:
              value:
                success: false
                message: One of phone, email, or search is required
            exclusif:
              value:
                success: false
                message: Provide exactly one of phone, email, or search
            queryInconnue:
              value:
                success: false
                message: 'Unsupported query parameter: foo'
            telephoneInvalide:
              value:
                success: false
                message: Invalid phone number
            emailInvalide:
              value:
                success: false
                message: Invalid email
            searchTropCourt:
              value:
                success: false
                message: search must be at least 3 characters
            pageHorsLimites:
              value:
                success: false
                message: page must be <= 100
            agencyGroupManquant:
              value:
                success: false
                message: LinkedAPI agencyGroup is required
    Unauthorized:
      description: >-
        Token invalide. Renvoyé quand le header `Authorization: Bearer` est
        présent mais que sa valeur n'est pas un token exploitable (malformé,
        signature invalide, valeur vide) — `message` vaut alors `Invalid bearer
        token`.


        Un token bien formé mais qui ne correspond plus à aucune clé (révoquée
        ou régénérée) donne aussi un `401`, avec le message `Not authorized to
        access this resource`.


        L'absence du header, une clé en lecture seule et une IP non autorisée
        renvoient un `403`, pas un `401`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            tokenInvalide:
              value:
                success: false
                message: Invalid bearer token
            cleInconnue:
              value:
                success: false
                message: Not authorized to access this resource
    Forbidden:
      description: >-
        Accès refusé. Trois causes donnent **exactement la même réponse** (même
        code, même `message`) :


        1. le header `Authorization` est absent ;

        2. la clé est en **lecture seule** et la requête est un `POST` ou un
        `PATCH` (voir le guide Authentification) ;

        3. la clé est en mode **sécurisé** et l'IP d'appel, lue dans
        `X-Real-IP`, n'est pas celle autorisée.


        Sur les routes d'écriture, un document lié hors du périmètre de la clé
        renvoie également ce `403`.


        Un `403` sur vos seules écritures alors que vos lectures passent = clé
        en lecture seule.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Not authorized to access this resource
    TooManyRequests:
      description: >-
        Limite de débit dépassée : limite de la route (par groupe d'agences et
        par chemin) ou limite globale (200 requêtes / 10 s par clé, `message`
        `Too many requests, please try again later`).
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
          example:
            success: false
            message: Rate limit exceeded
            retryAfter: 27
  securitySchemes:
    linkedApiToken:
      type: http
      scheme: bearer
      description: >-
        Token LinkedAPI avec scope `externalIntegration`. La clé doit avoir un
        `agencyGroup` configuré (sinon `400 LinkedAPI agencyGroup is required`).
        Fourni via l'en-tête `Authorization: Bearer {linkedAPI_token}`. Si la
        clé a `secure === true`, l'IP appelante doit être whitelistée (en-tête
        `X-Real-IP`), sinon `403 Not authorized to access this resource`.


        La clé porte aussi un **niveau d'accès** : en lecture seule, elle
        n'autorise que les `GET` ; un `POST` ou un `PATCH` renvoie alors `403
        Not authorized to access this resource`, soit la même réponse qu'une
        requête sans en-tête `Authorization`. Voir le guide Authentification.

````

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