{"items":[{"type":"link","label":"Immofacile API V2","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"Immofacile API V2"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary — © Orisha Real Estate","url":"https://www.orisha.com/mentions-legales/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base domain returned in the token response ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field)."},"children":[]}]}]}],"enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Immofacile API V2 (1.1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/openapi"}],"sectionId":"/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/welcome-to-the-immofacile-api"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Welcome to the Immofacile API"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This documentation will guide you through integrating with Immofacile, the leading SaaS CRM for real estate agencies. Our REST APIs allow you to connect your applications, automate your business workflows, and extend the power of our ecosystem."},"children":[]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/welcome-to-the-immofacile-api/target-audience"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target Audience"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This documentation and APIs are designed for three distinct types of users:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IT Departments (CIO) of large networks / Franchises:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Who want to interconnect Immofacile with their proprietary internal tools."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Developers / Partners:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Commissioned by our clients to build custom showcase websites or specific business applications."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Software Vendors (PropTech / Ecosystem Partners):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valuation tools, marketing automation providers, and any type of partner we want to connect to our system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Real estate listing portals:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Currently fed mostly via CSV or XML feeds, APIs are needed to better manage listing distribution and lead returns."},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/target-audience"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/target-audience"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/welcome-to-the-immofacile-api/1.-api-platform-overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1. API Platform Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Immofacile API is built on "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REST"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" standards. It uses standard HTTP request methods, explicit HTTP status codes, and a JSON response format."},"children":[]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/1.-api-platform-overview"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/1.-api-platform-overview"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/welcome-to-the-immofacile-api/1.1-\"api-first\"-philosophy"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1.1 \"API-First\" Philosophy"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To support the digitalization of real estate agencies, Immofacile offers a bidirectional architecture:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extraction (Read):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Securely access your client data (properties, contacts, events, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Injection (Write):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Create, update, or enrich the agency database (leads, properties, actions, etc.) while respecting the CRM's business rules."},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/1.1-\"api-first\"-philosophy"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/1.1-\"api-first\"-philosophy"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/welcome-to-the-immofacile-api/1.2-environments-and-authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1.2 Environments & Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox (Test):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" An isolated environment containing demo data for development without risk of polluting production (coming soon)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The agency's live environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Security:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Authentication relies on the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" protocol (via a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Client ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Client Secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" generated from the Immofacile admin dashboard) or by "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for simple internal script integrations."},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/1.2-environments-and-authentication"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/1.2-environments-and-authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/welcome-to-the-immofacile-api/2.-key-concepts-and-operating-rules"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2. Key Concepts & Operating Rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To interact effectively with Immofacile, you must understand two core pillars of our architecture: the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discovery API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for accessing authorized resources, and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for real-time synchronization."},"children":[]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/2.-key-concepts-and-operating-rules"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/2.-key-concepts-and-operating-rules"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/welcome-to-the-immofacile-api/2.1-discovery-(entry-point-discovery)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.1 Discovery (Entry Point Discovery)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To avoid hardcoding URLs and to dynamically adapt to the client agency's access rights, our API implements the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discovery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" principle."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The concept:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" By querying the single entry point, the API returns the list of all resources you have access to, along with associated URLs and available actions ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example request:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET https://api.immofacile.com/v2/"},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/2.1-discovery-(entry-point-discovery)"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/2.1-discovery-(entry-point-discovery)"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/welcome-to-the-immofacile-api/2.2-webhooks-(real-time-events)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.2 Webhooks (Real-Time Events)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intensive polling is prohibited on our platform. To synchronize your data in real time, you must use our "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" system. Rather than asking Immofacile whether data has changed, Immofacile sends an HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notification to your server as soon as an event occurs."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Each payload sent by our Webhook contains the event type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and the identifier of the related resource."},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/2.2-webhooks-(real-time-events)"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/2.2-webhooks-(real-time-events)"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/welcome-to-the-immofacile-api/3.-business-use-cases-and-implementation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3. Business Use Cases & Implementation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here is how to orchestrate our APIs to meet the real-world needs of real estate agents."},"children":[]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/3.-business-use-cases-and-implementation"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/3.-business-use-cases-and-implementation"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/welcome-to-the-immofacile-api/use-case-1:-create-update-a-lead-from-an-external-tool-(data-write)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Case 1: Create / Update a Lead from an External Tool (Data Write)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 1:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Duplicate check — Before creating a contact, the third-party application must verify the prospect does not already exist in the agency database via email or phone."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /customers/search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with email criterion"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 2:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Contact creation — If the contact does not exist, create it."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /customers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"firstname\": \"Jean\", \"lastname\": \"Dupont\", \"phone\": \"0601020304\", \"type\": \"Prospect Vendeur\"}"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 3:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Search project creation — Create the search project based on the property the contact inquired about."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 4:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Add property to contact follow-up — Associate the listing details to the contact so the agent has context during callback."},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/use-case-1:-create-update-a-lead-from-an-external-tool-(data-write)"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/use-case-1:-create-update-a-lead-from-an-external-tool-(data-write)"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/welcome-to-the-immofacile-api/use-case-2:-real-time-feed-for-agency-website-portal-partner-(data-read-and-webhooks)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Case 2: Real-Time Feed for Agency Website / Portal / Partner (Data Read & Webhooks)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 1:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Initialization (Full Sync) — On first connection, retrieve the entire active catalog."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 2:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Listen for updates (Delta Sync via Webhook) — Register the website URL on our webhook to listen for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property.updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action: Configuration via dashboard or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /hooks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to subscribe to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property.updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 3:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Targeted update — When a price changes or a property is sold in Immofacile, the website receives the webhook. It then queries the specific property to update its local database."},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/use-case-2:-real-time-feed-for-agency-website-portal-partner-(data-read-and-webhooks)"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/use-case-2:-real-time-feed-for-agency-website-portal-partner-(data-read-and-webhooks)"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/welcome-to-the-immofacile-api/4.-support-and-escalation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4. Support & Escalation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Having trouble with your integration?"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the Logs:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Every error response from our API contains a unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact dev support:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Send an email to api.imf@orisha.com, always including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the sent payload, and the environment concerned (Sandbox or Prod)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/4.-support-and-escalation"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/4.-support-and-escalation"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/welcome-to-the-immofacile-api/packs"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Packs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API is organized into packs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Products"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Property listings management"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Customer management, search requests, follow-ups, actions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Leads"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Seller and buyer lead creation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Users"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Agent/collaborator management"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Agency information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discovery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Scope discovery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Event subscriptions"},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/packs"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/packs"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/welcome-to-the-immofacile-api/access-packs-(endpoint-badges)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access packs (endpoint badges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each endpoint carries one or more colored badges indicating which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription pack(s) grant access to it. An endpoint may belong to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"several packs. Use these badges to check whether your subscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"covers a given endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Badge"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access pack"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🟣 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers, search requests, follow-ups, actions"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"purple"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🟢 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Properties"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Property listings and criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"green"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🟠 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Leads"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seller and buyer lead creation"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orange"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔴 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sales"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale agreements, offers, leases"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"red"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🟪 "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Websites"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read feeds for websites and portals"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"blueberry"},"children":[]}]}]}]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/access-packs-(endpoint-badges)"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/access-packs-(endpoint-badges)"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/welcome-to-the-immofacile-api/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain a Bearer token via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/client/token/site"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (OAuth2 client credentials)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include it in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for all requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL is dynamic."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The token response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Use it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as the base for every subsequent call ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{domain}/api/v2/site/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). In the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it console, set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" server variable to that value."},"children":[]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/authentication"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/welcome-to-the-immofacile-api/error-format"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error format"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{ \"error\": { \"code\": \"ERROR_CODE\", \"message\": \"Human-readable message.\" } }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{ \"error\": { \"code\": \"ERROR_CODE\", \"message\": \"Human-readable message.\" } }\n"},"children":[]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/error-format"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/error-format"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/welcome-to-the-immofacile-api/pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List endpoints use cursor-based pagination: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_more"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/pagination"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/pagination"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/welcome-to-the-immofacile-api/headers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All responses include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Request-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (UUID) for log correlation."},"children":[]}]}]}]}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/headers"}],"sectionId":"/openapi/section/welcome-to-the-immofacile-api/headers"}]}]}},{"type":"group","label":"Welcome to the Immofacile API","link":"/openapi/section/welcome-to-the-immofacile-api","routeSlug":"/openapi/section/welcome-to-the-immofacile-api","items":[{"type":"link","label":"Target Audience","link":"/openapi/section/welcome-to-the-immofacile-api/target-audience","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/target-audience","content":null},{"type":"link","label":"1. API Platform Overview","link":"/openapi/section/welcome-to-the-immofacile-api/1.-api-platform-overview","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/1.-api-platform-overview","content":null},{"type":"link","label":"1.1 \"API-First\" Philosophy","link":"/openapi/section/welcome-to-the-immofacile-api/1.1-\"api-first\"-philosophy","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/1.1-\"api-first\"-philosophy","content":null},{"type":"link","label":"1.2 Environments & Authentication","link":"/openapi/section/welcome-to-the-immofacile-api/1.2-environments-and-authentication","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/1.2-environments-and-authentication","content":null},{"type":"link","label":"2. Key Concepts & Operating Rules","link":"/openapi/section/welcome-to-the-immofacile-api/2.-key-concepts-and-operating-rules","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/2.-key-concepts-and-operating-rules","content":null},{"type":"link","label":"2.1 Discovery (Entry Point Discovery)","link":"/openapi/section/welcome-to-the-immofacile-api/2.1-discovery-(entry-point-discovery)","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/2.1-discovery-(entry-point-discovery)","content":null},{"type":"link","label":"2.2 Webhooks (Real-Time Events)","link":"/openapi/section/welcome-to-the-immofacile-api/2.2-webhooks-(real-time-events)","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/2.2-webhooks-(real-time-events)","content":null},{"type":"link","label":"3. Business Use Cases & Implementation","link":"/openapi/section/welcome-to-the-immofacile-api/3.-business-use-cases-and-implementation","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/3.-business-use-cases-and-implementation","content":null},{"type":"link","label":"Use Case 1: Create / Update a Lead from an External Tool (Data Write)","link":"/openapi/section/welcome-to-the-immofacile-api/use-case-1:-create-update-a-lead-from-an-external-tool-(data-write)","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/use-case-1:-create-update-a-lead-from-an-external-tool-(data-write)","content":null},{"type":"link","label":"Use Case 2: Real-Time Feed for Agency Website / Portal / Partner (Data Read & Webhooks)","link":"/openapi/section/welcome-to-the-immofacile-api/use-case-2:-real-time-feed-for-agency-website-portal-partner-(data-read-and-webhooks)","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/use-case-2:-real-time-feed-for-agency-website-portal-partner-(data-read-and-webhooks)","content":null},{"type":"link","label":"4. Support & Escalation","link":"/openapi/section/welcome-to-the-immofacile-api/4.-support-and-escalation","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/4.-support-and-escalation","content":null},{"type":"link","label":"Packs","link":"/openapi/section/welcome-to-the-immofacile-api/packs","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/packs","content":null},{"type":"link","label":"Access packs (endpoint badges)","link":"/openapi/section/welcome-to-the-immofacile-api/access-packs-(endpoint-badges)","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/access-packs-(endpoint-badges)","content":null},{"type":"link","label":"Authentication","link":"/openapi/section/welcome-to-the-immofacile-api/authentication","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/authentication","content":null},{"type":"link","label":"Error format","link":"/openapi/section/welcome-to-the-immofacile-api/error-format","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/error-format","content":null},{"type":"link","label":"Pagination","link":"/openapi/section/welcome-to-the-immofacile-api/pagination","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/pagination","content":null},{"type":"link","label":"Headers","link":"/openapi/section/welcome-to-the-immofacile-api/headers","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/headers","content":null}],"content":null},{"type":"separator","label":"API Reference","content":null},{"type":"group","label":"Authentication","link":"/openapi/authentication","routeSlug":"/openapi/authentication","items":[{"label":"Obtain a site access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/authentication/obtainsitetoken","routeSlug":"/openapi/authentication/obtainsitetoken","metadata":{"seo":{"title":"Obtain a site access token","description":"Authenticate using client credentials to obtain a Bearer token scoped to a site.This endpoint is shared between V1 and V2.The token must be included in the Authorization: Bearer {token} header for all subsequent requests."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obtainSiteToken","name":"Obtain a site access token","isWebhook":false,"pointer":"/paths/~1api~1client~1token~1site/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Obtain a site access token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate using client credentials to obtain a Bearer token scoped to a site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is shared between V1 and V2."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token must be included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for all subsequent requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass your credentials in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header using HTTP Basic Auth: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Basic base64(client_id:client_secret)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"site_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manufacturer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to scope the token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-Agency Scoping:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication is linked to a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Site"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A Site groups one or more agencies (manufacturers)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your token grants access to all agencies in the Site's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manufacturers_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agency_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in requests must reference an agency within that scope."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /agencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list accessible agencies for your token."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-site scenarios:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option A: One Site grouping all agencies (single credential, single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"site_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option B: Multiple credentials (one per Site), each accessing a subset of agencies. You obtain a separate token for each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"site_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example (curl):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST 'https://v2.immo-facile.com/api/client/token/site' \\\n  -H 'Content-Type: application/x-www-form-urlencoded' \\\n  -H 'Authorization: Basic base64(client_id:client_secret)' \\\n  --data-urlencode 'site_id=12345'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST 'https://v2.immo-facile.com/api/client/token/site' \\\n  -H 'Content-Type: application/x-www-form-urlencoded' \\\n  -H 'Authorization: Basic base64(client_id:client_secret)' \\\n  --data-urlencode 'site_id=12345'\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic Auth with client_id as username and client_secret as password (base64 encoded)"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_70"}},"schemaId":"schema_70","pointer":"/paths/~1api~1client~1token~1site/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/client/token/site","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://v2.immo-facile.com","description":"Production (auth endpoint)"},{"url":"https://ac3.staging.immo-facile.com","description":"Staging (auth endpoint)"},{"url":"https://ac3.recette1.immo-facile.com","description":"Recette 1 (auth endpoint)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_70"}},"responseCodes":["200","401","403","404","422"],"pointer":"/api/client/token/site","href":"authentication/obtainsitetoken","openApiOperationId":"obtainSiteToken","summary":"Obtain a site access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://v2.immo-facile.com","description":"Production (auth endpoint)"},{"url":"https://ac3.staging.immo-facile.com","description":"Staging (auth endpoint)"},{"url":"https://ac3.recette1.immo-facile.com","description":"Recette 1 (auth endpoint)"}],"schemaId":"schema_70","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_70"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Token issued successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_71"}},"schemaId":"schema_71"},{"code":"401","description":"Invalid credentials or missing Authorization header"},{"code":"403","description":"Site or manufacturer not in scope for this client"},{"code":"404","description":"Site or manufacturer not found"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error (missing site_id or manufacturer_id)"},"children":[]}]}]}]}],"pointer":"/paths/~1api~1client~1token~1site/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_71","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_71"}}},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/obtainsitetoken"}],"panels":[]}]},"httpPath":"/api/client/token/site"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true},{"nodeType":"markdoc","content":"OAuth 2.0 token retrieval and API authentication."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/client/token/site","summary":"Obtain a site access token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/obtainsitetoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/openapi/products","routeSlug":"/openapi/products","items":[{"label":"Create a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/products/createproduct","routeSlug":"/openapi/products/createproduct","metadata":{"seo":{"title":"Create a product","description":"Creates a new product (property listing)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProduct","name":"Create a product","isWebhook":false,"pointer":"/paths/~1products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a product","badges":[{"name":"Properties","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new product (property listing)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each criterion is an object with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (criteria identifier) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"either"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the XML identifier (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"TypeBien\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"NbPieces\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Surface\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the numeric ID (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"27\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Both are resolved by the validator."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value format depends on criteria type: string for UNIQUE, number for NUMBER, boolean 0/1 for FLAG, array for MULTIPLE, ISO date for DATE."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For UNIQUE/MULTIPLE types, the value must exactly match a valid "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field) from the referential. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criterias/product/{id}/values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover valid values."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ Important — UNIQUE criteria values:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for UNIQUE criteria must be the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values endpoint), NOT the numeric ID. For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"✅ Correct: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"id\": \"TypeBien\", \"value\": \"Appartement\"}"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"❌ Wrong: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"id\": \"TypeBien\", \"value\": \"1\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (this is the value ID, not the code)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The values endpoint ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criterias/product/{id}/values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") returns objects like:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{ \"id\": 1, \"model\": \"Appartement\", \"label\": \"Appartement\" }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{ \"id\": 1, \"model\": \"Appartement\", \"label\": \"Appartement\" }\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in your criteria array."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Statut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" criterion):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product is only "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"active and visible"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the interface when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Statut = \"EnCours\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do NOT send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Statut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" criterion, the system applies the site's default"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value (configured per site). This default is usually "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"EnCours\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (active), but some"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sites may have a different default — in that case the product may not be immediately"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visible in the interface."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommendation:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Always explicitly include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"id\": \"Statut\", \"value\": \"EnCours\"}"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in your criteria array to ensure the product is immediately active."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DPE (Energy Performance):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send numeric values via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conso_energ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (kWh/m²/year) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valeur_GES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (kgCO₂/m²/year)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically calculates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the DPE/GES letter (A-G) from numerical values based on property type and country."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you already know the letter, send it directly via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConsoEner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" criteria instead."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geolocation (GPS):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Alentour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" criterion is provided (format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"lat,lng\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"48.8566,2.3522\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), it is used directly as the property's GPS coordinates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Alentour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is NOT provided, the system "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically geocodes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Adresse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CodePostal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ville"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" criteria. Fallback: geocodes from city+postal code only."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Model (reference):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is the property's internal reference number (mandate number, agency reference)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If omitted, the system auto-generates the next available reference for the agency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use it to store your own identifier for cross-referencing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rooms ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rooms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each room has a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (validated against referential list 1), optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surface"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"niveau"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (list 2), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (list 3), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (list 4), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commentaire"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /configs/listes/{listeId}/values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover valid values (1=room types, 2=expositions, 3=views, 4=floor types)."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProductRequest"}},"schemaId":"components/schemas/CreateProductRequest","pointer":"/paths/~1products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateProductRequest"}},"responseCodes":["201","403","422"],"pointer":"/products","href":"products/createproduct","openApiOperationId":"createProduct","summary":"Create a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/CreateProductRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateProductRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Product created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_72"}},"schemaId":"schema_72"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1products/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_72","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_72"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/createproduct"}],"panels":[]}]},"badges":[{"name":"Properties","color":"green"}],"httpPath":"/products"},{"label":"Search products","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/products/searchproducts","routeSlug":"/openapi/products/searchproducts","metadata":{"seo":{"title":"Search products","description":"Searches products by criteria with cursor-based or offset-based pagination.Requires SITE_PRODUCT:READ permission and RS:PRODUCT_SEARCH right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchProducts","name":"Search products","isWebhook":false,"pointer":"/paths/~1products~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search products","badges":[{"name":"Properties","color":"green"},{"name":"Websites","color":"blueberry"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches products by criteria with cursor-based or offset-based pagination."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_PRODUCT:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:PRODUCT_SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination modes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor-based (recommended):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the next page. Order is by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"products_id ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offset-based (legacy):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns up to 2000 IDs."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response format:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?fetch="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": returns only product IDs (lightweight)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?fetch=criteres_text,descriptions,..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": returns hydrated product objects"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the requested related data."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering by user (agent):"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"products_admin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter by assigned agent. Accepts an array of IDs"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or a comma-separated string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria operators:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operator"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EGAL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DIFFERENT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not equal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPERIEUR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Greater than or equal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFERIEUR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Less than or equal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTIENT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains (multi-value text)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPREND"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes (array contains)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NE_COMPREND_PAS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Does not include"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fetch","in":"query","schemaId":"schema_73","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of additional related data to include for each product."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applies when results are hydrated (not for ID-only responses)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available values:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteres_text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Text criteria values"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteres_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Numeric criteria values"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteres_fulltext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Full-text criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteres_flag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Boolean criteria"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteres_publication_errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Criteria blocking publication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"descriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Web descriptions (multilingual)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rooms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Room details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"products_photos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Photo URLs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Seller/owner contact"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assigned_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Assigned agent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Creator agent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"publications"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Publication/distribution status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actions_history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Action log"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sale_agreement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Related compromis"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_sale_agreement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Active compromis only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"log_actions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Action log entries"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"live_visit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Live visit data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scopes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Permission scopes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statistic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Statistics data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — INSEE code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"online_booking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Online booking config"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Product category"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"themes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Associated themes"},"children":[]}]}]}]}],"example":["criteres_text","criteres_number","descriptions","products_photos","customer"]}],"pointer":"/paths/~1products~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_74","exampleIds":["paths/~1products~1search/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_74","exampleIds":["paths/~1products~1search/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1products~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products/search","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[{"name":"fetch","in":"query","required":false,"example":["criteres_text","criteres_number","descriptions","products_photos","customer"],"schemaId":"schema_73","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_74","exampleIds":["paths/~1products~1search/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","403","422"],"pointer":"/products/search","href":"products/searchproducts","openApiOperationId":"searchProducts","summary":"Search products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"schema_74","exampleIds":["paths/~1products~1search/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_74","exampleIds":["paths/~1products~1search/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Search results","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_75"}},"schemaId":"schema_75"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1products~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_75","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_75"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/searchproducts"}],"panels":[]}]},"badges":[{"name":"Properties","color":"green"},{"name":"Websites","color":"blueberry"}],"httpPath":"/products/search"},{"label":"Count search results","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/products/countproductsearch","routeSlug":"/openapi/products/countproductsearch","metadata":{"seo":{"title":"Count search results","description":"Returns the number of products matching the given criteria."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"countProductSearch","name":"Count search results","isWebhook":false,"pointer":"/paths/~1products~1search~1count/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Count search results","badges":[{"name":"Properties","color":"green"},{"name":"Websites","color":"blueberry"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the number of products matching the given criteria."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_76"}},"schemaId":"schema_76","pointer":"/paths/~1products~1search~1count/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products/search/count","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_76"}},"responseCodes":["200","403"],"pointer":"/products/search/count","href":"products/countproductsearch","openApiOperationId":"countProductSearch","summary":"Count search results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"schema_76","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_76"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Count result","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1products~1search~1count/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/countproductsearch"}],"panels":[]}]},"badges":[{"name":"Properties","color":"green"},{"name":"Websites","color":"blueberry"}],"httpPath":"/products/search/count"},{"label":"Get a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/products/getproduct","routeSlug":"/openapi/products/getproduct","metadata":{"seo":{"title":"Get a product","description":"Returns detailed information about a product.Requires SITE_PRODUCT:READ permission and RS:PRODUCT_GET right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProduct","name":"Get a product","isWebhook":false,"pointer":"/paths/~1products~1{productId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a product","badges":[{"name":"Properties","color":"green"},{"name":"Sales","color":"red"},{"name":"Websites","color":"blueberry"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns detailed information about a product."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_PRODUCT:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:PRODUCT_GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?fetch="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include additional related data (same values as search endpoint)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?fetch="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", returns the base product fields via the standard resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"productId","in":"path","schemaId":"schema_78","description":"Unique identifier of the product.","required":true,"example":12345}],"pointer":"/paths/~1products~1{productId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fetch","in":"query","schemaId":"schema_79","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of additional data to include"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteres_text,descriptions,products_photos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same values as the search endpoint's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?fetch="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}],"example":"criteres_text,criteres_number,descriptions,rooms,products_photos"}],"pointer":"/paths/~1products~1{productId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products/{productId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"productId","in":"path","required":true,"example":12345,"schemaId":"schema_78"}],"query":[{"name":"fetch","in":"query","required":false,"example":"criteres_text,criteres_number,descriptions,rooms,products_photos","schemaId":"schema_79"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/products/{productId}","href":"products/getproduct","openApiOperationId":"getProduct","summary":"Get a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1products~1{productId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getproduct"}],"panels":[]}]},"badges":[{"name":"Properties","color":"green"},{"name":"Sales","color":"red"},{"name":"Websites","color":"blueberry"}],"httpPath":"/products/{productId}"},{"label":"Update a product","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/products/updateproduct","routeSlug":"/openapi/products/updateproduct","metadata":{"seo":{"title":"Update a product","description":"Partially updates a product. Only provided fields are modified.Requires SITE_PRODUCT:WRITE permission and RS:PRODUCT_UPDATE right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProduct","name":"Update a product","isWebhook":false,"pointer":"/paths/~1products~1{productId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a product","badges":[{"name":"Properties","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates a product. Only provided fields are modified."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_PRODUCT:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:PRODUCT_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The request body must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same value as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path parameter) — used for scope verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, only the specified criteria are updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing criteria not included in the array are preserved (not reset)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rooms:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rooms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, rooms can be updated by including their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or new rooms can be added without an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In update mode, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mutually exclusive on a given room."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional updatable fields:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Change product reference"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agency_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Transfer to another agency (must remain in scope)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Change assigned agent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"web_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Enable/disable web publishing (boolean)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intercabinet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Enable/disable inter-agency sharing (boolean)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller_statistics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Enable/disable seller statistics (boolean)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_contact"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Next follow-up date (format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Color code (1-5)"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"productId","in":"path","schemaId":"schema_78","description":"Unique identifier of the product to update.","required":true,"example":12345}],"pointer":"/paths/~1products~1{productId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateProductRequest","exampleIds":["paths/~1products~1{productId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateProductRequest","exampleIds":["paths/~1products~1{productId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1products~1{productId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/products/{productId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"productId","in":"path","required":true,"example":12345,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateProductRequest","exampleIds":["paths/~1products~1{productId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","403","404","422"],"pointer":"/products/{productId}","href":"products/updateproduct","openApiOperationId":"updateProduct","summary":"Update a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/UpdateProductRequest","exampleIds":["paths/~1products~1{productId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateProductRequest","exampleIds":["paths/~1products~1{productId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Updated successfully"},{"code":"400","description":"Invalid criteria. Response contains details about which criteria\nvalue was not recognized.\n"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1products~1{productId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/updateproduct"}],"panels":[]}]},"badges":[{"name":"Properties","color":"green"}],"httpPath":"/products/{productId}"},{"label":"Get product criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/products/getproductcriteriavalues","routeSlug":"/openapi/products/getproductcriteriavalues","metadata":{"seo":{"title":"Get product criteria","description":"Returns the criteria values for a product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductCriteriaValues","name":"Get product criteria","isWebhook":false,"pointer":"/paths/~1products~1{productId}~1criteria/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get product criteria","badges":[{"name":"Properties","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the criteria values for a product."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"productId","in":"path","schemaId":"schema_78","required":true}],"pointer":"/paths/~1products~1{productId}~1criteria/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products/{productId}/criteria","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"productId","in":"path","required":true,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/products/{productId}/criteria","href":"products/getproductcriteriavalues","openApiOperationId":"getProductCriteriaValues","summary":"Get product criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product criteria","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81"}},"schemaId":"schema_81"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1products~1{productId}~1criteria/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_81","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getproductcriteriavalues"}],"panels":[]}]},"badges":[{"name":"Properties","color":"green"}],"httpPath":"/products/{productId}/criteria"},{"label":"Get product lots","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/products/getproductlots","routeSlug":"/openapi/products/getproductlots","metadata":{"seo":{"title":"Get product lots","description":"Returns the lots associated with a product (sub-products, e.g. units in a building)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductLots","name":"Get product lots","isWebhook":false,"pointer":"/paths/~1products~1{productId}~1lots/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get product lots","badges":[{"name":"Properties","color":"green"},{"name":"Websites","color":"blueberry"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the lots associated with a product (sub-products, e.g. units in a building)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"productId","in":"path","schemaId":"schema_78","required":true}],"pointer":"/paths/~1products~1{productId}~1lots/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fetch","in":"query","schemaId":"schema_79","description":"Additional data to include (comma-separated)"}],"pointer":"/paths/~1products~1{productId}~1lots/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products/{productId}/lots","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"productId","in":"path","required":true,"schemaId":"schema_78"}],"query":[{"name":"fetch","in":"query","schemaId":"schema_79"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/products/{productId}/lots","href":"products/getproductlots","openApiOperationId":"getProductLots","summary":"Get product lots"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Product lots","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}},"schemaId":"schema_82"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1products~1{productId}~1lots/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_82","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getproductlots"}],"panels":[]}]},"badges":[{"name":"Properties","color":"green"},{"name":"Websites","color":"blueberry"}],"httpPath":"/products/{productId}/lots"},{"label":"Add a public photo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/products/addproductpublicphoto","routeSlug":"/openapi/products/addproductpublicphoto","metadata":{"seo":{"title":"Add a public photo","description":"Uploads a public photo for a product. Minimum width 800px, max 20MB."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addProductPublicPhoto","name":"Add a public photo","isWebhook":false,"pointer":"/paths/~1products~1{productId}~1pictures~1public/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a public photo","badges":[{"name":"Properties","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Uploads a public photo for a product. Minimum width 800px, max 20MB."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"productId","in":"path","schemaId":"schema_78","required":true}],"pointer":"/paths/~1products~1{productId}~1pictures~1public/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_83"}},"schemaId":"schema_83","pointer":"/paths/~1products~1{productId}~1pictures~1public/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products/{productId}/pictures/public","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"productId","in":"path","required":true,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_83"}},"responseCodes":["204","403","422"],"pointer":"/products/{productId}/pictures/public","href":"products/addproductpublicphoto","openApiOperationId":"addProductPublicPhoto","summary":"Add a public photo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"schema_83","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_83"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Photo added successfully"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1products~1{productId}~1pictures~1public/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/addproductpublicphoto"}],"panels":[]}]},"badges":[{"name":"Properties","color":"green"}],"httpPath":"/products/{productId}/pictures/public"},{"label":"Add a private photo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/products/addproductprivatephoto","routeSlug":"/openapi/products/addproductprivatephoto","metadata":{"seo":{"title":"Add a private photo","description":"Uploads a private photo for a product. Minimum width 800px, max 20MB."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addProductPrivatePhoto","name":"Add a private photo","isWebhook":false,"pointer":"/paths/~1products~1{productId}~1pictures~1private/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a private photo","badges":[{"name":"Properties","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Uploads a private photo for a product. Minimum width 800px, max 20MB."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"productId","in":"path","schemaId":"schema_78","required":true}],"pointer":"/paths/~1products~1{productId}~1pictures~1private/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_83"}},"schemaId":"schema_83","pointer":"/paths/~1products~1{productId}~1pictures~1private/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products/{productId}/pictures/private","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"productId","in":"path","required":true,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_83"}},"responseCodes":["204","403","422"],"pointer":"/products/{productId}/pictures/private","href":"products/addproductprivatephoto","openApiOperationId":"addProductPrivatePhoto","summary":"Add a private photo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"schema_83","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_83"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Photo added successfully"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1products~1{productId}~1pictures~1private/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/addproductprivatephoto"}],"panels":[]}]},"badges":[{"name":"Properties","color":"green"}],"httpPath":"/products/{productId}/pictures/private"},{"label":"List actions for a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/products/listproductactions","routeSlug":"/openapi/products/listproductactions","metadata":{"seo":{"title":"List actions for a product","description":"Returns paginated action history for a product."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProductActions","name":"List actions for a product","isWebhook":false,"pointer":"/paths/~1products~1{productId}~1actions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List actions for a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns paginated action history for a product."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"productId","in":"path","schemaId":"schema_78","required":true}],"pointer":"/paths/~1products~1{productId}~1actions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_78"}],"pointer":"/paths/~1products~1{productId}~1actions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products/{productId}/actions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"productId","in":"path","required":true,"schemaId":"schema_78"}],"query":[{"name":"cursor","in":"query","schemaId":"schema_78"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/products/{productId}/actions","href":"products/listproductactions","openApiOperationId":"listProductActions","summary":"List actions for a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of actions"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1products~1{productId}~1actions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/listproductactions"}],"panels":[]}]},"httpPath":"/products/{productId}/actions"},{"label":"Create an action for a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/products/createproductaction","routeSlug":"/openapi/products/createproductaction","metadata":{"seo":{"title":"Create an action for a product","description":"Logs a new action on a product record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProductAction","name":"Create an action for a product","isWebhook":false,"pointer":"/paths/~1products~1{productId}~1actions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an action for a product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Logs a new action on a product record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The action is always recorded in the application log (journal). However, it will only appear in the product's action history tab if the action type has child actions configured for the site. This depends on the agency's action workflow configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To determine if an action type has child actions (and will therefore appear in the product history), check the action type configuration in the back-office or use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /actions/types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list available types."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"productId","in":"path","schemaId":"schema_78","required":true}],"pointer":"/paths/~1products~1{productId}~1actions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_84"}},"schemaId":"schema_84","pointer":"/paths/~1products~1{productId}~1actions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products/{productId}/actions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"productId","in":"path","required":true,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_84"}},"responseCodes":["201","403","404","422"],"pointer":"/products/{productId}/actions","href":"products/createproductaction","openApiOperationId":"createProductAction","summary":"Create an action for a product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"schema_84","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_84"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Action created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_85"}},"schemaId":"schema_85"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1products~1{productId}~1actions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_85","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_85"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/createproductaction"}],"panels":[]}]},"httpPath":"/products/{productId}/actions"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":"Property listings management (create, search, read, media, actions)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/products","summary":"Create a product","prefix":{"name":"post","color":"post"},"badges":[{"name":"Properties","color":"green"}],"link":"/products/createproduct","deprecated":false},{"title":"/products/search","summary":"Search products","prefix":{"name":"post","color":"post"},"badges":[{"name":"Properties","color":"green"},{"name":"Websites","color":"blueberry"}],"link":"/products/searchproducts","deprecated":false},{"title":"/products/search/count","summary":"Count search results","prefix":{"name":"post","color":"post"},"badges":[{"name":"Properties","color":"green"},{"name":"Websites","color":"blueberry"}],"link":"/products/countproductsearch","deprecated":false},{"title":"/products/{productId}","summary":"Get a product","prefix":{"name":"get","color":"get"},"badges":[{"name":"Properties","color":"green"},{"name":"Sales","color":"red"},{"name":"Websites","color":"blueberry"}],"link":"/products/getproduct","deprecated":false},{"title":"/products/{productId}","summary":"Update a product","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Properties","color":"green"}],"link":"/products/updateproduct","deprecated":false},{"title":"/products/{productId}/criteria","summary":"Get product criteria","prefix":{"name":"get","color":"get"},"badges":[{"name":"Properties","color":"green"}],"link":"/products/getproductcriteriavalues","deprecated":false},{"title":"/products/{productId}/lots","summary":"Get product lots","prefix":{"name":"get","color":"get"},"badges":[{"name":"Properties","color":"green"},{"name":"Websites","color":"blueberry"}],"link":"/products/getproductlots","deprecated":false},{"title":"/products/{productId}/pictures/public","summary":"Add a public photo","prefix":{"name":"post","color":"post"},"badges":[{"name":"Properties","color":"green"}],"link":"/products/addproductpublicphoto","deprecated":false},{"title":"/products/{productId}/pictures/private","summary":"Add a private photo","prefix":{"name":"post","color":"post"},"badges":[{"name":"Properties","color":"green"}],"link":"/products/addproductprivatephoto","deprecated":false},{"title":"/products/{productId}/actions","summary":"List actions for a product","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/listproductactions","deprecated":false},{"title":"/products/{productId}/actions","summary":"Create an action for a product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/createproductaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Criterias","link":"/openapi/criterias","routeSlug":"/openapi/criterias","items":[{"label":"Get all product criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/criterias/listproductcriteria","routeSlug":"/openapi/criterias/listproductcriteria","metadata":{"seo":{"title":"Get all product criteria","description":"Returns all product criteria definitions for the site, including type,label, activation state and personalisation flags.Requires SITE_CONFIG permission and RS:CRITERE_PRODUCT_ALL right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProductCriteria","name":"Get all product criteria","isWebhook":false,"pointer":"/paths/~1criterias~1product~1all/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all product criteria","badges":[{"name":"Leads","color":"orange"},{"name":"Properties","color":"green"},{"name":"Customers","color":"purple"},{"name":"Websites","color":"blueberry"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all product criteria definitions for the site, including type,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"label, activation state and personalisation flags."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CONFIG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:CRITERE_PRODUCT_ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria types:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value format"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIQUE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single choice from predefined values"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value code string"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric value"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number (int or float)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FLAG"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TEXT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MULTIPLE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple choice from predefined values"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of value code strings"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date/datetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dd/MM/yyyy"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criterias/product/{id}/values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the valid values for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIQUE/MULTIPLE type criteria."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common criteria examples:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"XML Key"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TypeBien"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIQUE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Property type (Appartement, Maison, Terrain...)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TypeTransaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIQUE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction type (Vente, Location...)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NbPieces"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NUMBER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of rooms"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Surface"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NUMBER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Living area in m²"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Prix"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NUMBER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conso_energ"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NUMBER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Energy consumption (kWh/m²/year)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConsoEner"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIQUE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DPE letter (A-G, auto-calculated from conso_energ)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Adresse"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEXT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Street address"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CodePostal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEXT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ville"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEXT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Alentour"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEXT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GPS coordinates ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"lat,lng\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/criterias/product/all","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/criterias/product/all","href":"criterias/listproductcriteria","openApiOperationId":"listProductCriteria","summary":"Get all product criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of product criteria","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_86"}},"schemaId":"schema_86"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1criterias~1product~1all/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_86","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_86"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/criterias/listproductcriteria"}],"panels":[]}]},"badges":[{"name":"Leads","color":"orange"},{"name":"Properties","color":"green"},{"name":"Customers","color":"purple"},{"name":"Websites","color":"blueberry"}],"httpPath":"/criterias/product/all"},{"label":"Get a product criteria by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/criterias/getproductcriteria","routeSlug":"/openapi/criterias/getproductcriteria","metadata":{"seo":{"title":"Get a product criteria by ID","description":"Returns a single product criteria definition with its possible values.Requires SITE_CONFIG permission and RS:CRITERE_PRODUCT right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductCriteria","name":"Get a product criteria by ID","isWebhook":false,"pointer":"/paths/~1criterias~1product~1{criteriaId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a product criteria by ID","badges":[{"name":"Leads","color":"orange"},{"name":"Properties","color":"green"},{"name":"Customers","color":"purple"},{"name":"Websites","color":"blueberry"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a single product criteria definition with its possible values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CONFIG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:CRITERE_PRODUCT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"criteriaId","in":"path","schemaId":"schema_78","description":"Criteria ID (numeric).","required":true,"example":27}],"pointer":"/paths/~1criterias~1product~1{criteriaId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/criterias/product/{criteriaId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"criteriaId","in":"path","required":true,"example":27,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/criterias/product/{criteriaId}","href":"criterias/getproductcriteria","openApiOperationId":"getProductCriteria","summary":"Get a product criteria by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Criteria details with values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_87"}},"schemaId":"schema_87"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1criterias~1product~1{criteriaId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_87","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_87"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/criterias/getproductcriteria"}],"panels":[]}]},"badges":[{"name":"Leads","color":"orange"},{"name":"Properties","color":"green"},{"name":"Customers","color":"purple"},{"name":"Websites","color":"blueberry"}],"httpPath":"/criterias/product/{criteriaId}"},{"label":"Get search request criteria","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/criterias/listsearchrequestcriteria","routeSlug":"/openapi/criterias/listsearchrequestcriteria","metadata":{"seo":{"title":"Get search request criteria","description":"Returns the criteria available for buyer search requests on this site.Requires SITE_CONFIG permission and RS:CRITERE_SR_LIST right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSearchRequestCriteria","name":"Get search request criteria","isWebhook":false,"pointer":"/paths/~1criterias~1search-requests/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get search request criteria","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the criteria available for buyer search requests on this site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CONFIG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:CRITERE_SR_LIST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use these criteria IDs when creating search requests via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /leads/buyers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /customers/{id}/search-requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/criterias/search-requests","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/criterias/search-requests","href":"criterias/listsearchrequestcriteria","openApiOperationId":"listSearchRequestCriteria","summary":"Get search request criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of search request criteria","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_86"}},"schemaId":"schema_86"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1criterias~1search-requests/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_86","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_86"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/criterias/listsearchrequestcriteria"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/criterias/search-requests"},{"label":"Get zone list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/criterias/getzonelist","routeSlug":"/openapi/criterias/getzonelist","metadata":{"seo":{"title":"Get zone list","description":"Returns the list of geographic zones available for the site.Requires SITE_CONFIG permission and RS:CRITERE_ZONE_LIST right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getZoneList","name":"Get zone list","isWebhook":false,"pointer":"/paths/~1criterias~1zone-list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get zone list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of geographic zones available for the site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CONFIG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:CRITERE_ZONE_LIST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zones are used in search request criteria (typically criterion ID 30)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to filter properties by location."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responses are cached with ETag."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"manufacturer_id","in":"query","schemaId":"schema_78","description":"Optional agency ID to get the zone list for a different site context.\nMust be within the authenticated scope.\n"}],"pointer":"/paths/~1criterias~1zone-list/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/criterias/zone-list","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[{"name":"manufacturer_id","in":"query","required":false,"schemaId":"schema_78"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/criterias/zone-list","href":"criterias/getzonelist","openApiOperationId":"getZoneList","summary":"Get zone list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of zones","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_73","exampleIds":["paths/~1criterias~1zone-list/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_73","exampleIds":["paths/~1criterias~1zone-list/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1criterias~1zone-list/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_73","exampleIds":["paths/~1criterias~1zone-list/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_73","exampleIds":["paths/~1criterias~1zone-list/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/criterias/getzonelist"}],"panels":[]}]},"httpPath":"/criterias/zone-list"},{"label":"Get criteria by category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/criterias/getcriteriabycategory","routeSlug":"/openapi/criterias/getcriteriabycategory","metadata":{"seo":{"title":"Get criteria by category","description":"Returns the criteria belonging to a given product category.Requires SITE_CONFIG permission and RS:CRITERE_CATEGORY right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCriteriaByCategory","name":"Get criteria by category","isWebhook":false,"pointer":"/paths/~1criterias~1categories~1{categoryId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get criteria by category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the criteria belonging to a given product category."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CONFIG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:CRITERE_CATEGORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Categories group criteria by property type (e.g. criteria specific to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"apartments vs. houses vs. land)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"categoryId","in":"path","schemaId":"schema_78","description":"Category ID.","required":true,"example":1}],"pointer":"/paths/~1criterias~1categories~1{categoryId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/criterias/categories/{categoryId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"categoryId","in":"path","required":true,"example":1,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/criterias/categories/{categoryId}","href":"criterias/getcriteriabycategory","openApiOperationId":"getCriteriaByCategory","summary":"Get criteria by category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Criteria in the category","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_86"}},"schemaId":"schema_86"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1criterias~1categories~1{categoryId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_86","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_86"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/criterias/getcriteriabycategory"}],"panels":[]}]},"httpPath":"/criterias/categories/{categoryId}"}],"content":{"contentType":"group","meta":{"name":"Criterias"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Criterias","showPageActions":true},{"nodeType":"markdoc","content":"Property and search-request criteria referential (types and allowed values)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/criterias/product/all","summary":"Get all product criteria","prefix":{"name":"get","color":"get"},"badges":[{"name":"Leads","color":"orange"},{"name":"Properties","color":"green"},{"name":"Customers","color":"purple"},{"name":"Websites","color":"blueberry"}],"link":"/criterias/listproductcriteria","deprecated":false},{"title":"/criterias/product/{criteriaId}","summary":"Get a product criteria by ID","prefix":{"name":"get","color":"get"},"badges":[{"name":"Leads","color":"orange"},{"name":"Properties","color":"green"},{"name":"Customers","color":"purple"},{"name":"Websites","color":"blueberry"}],"link":"/criterias/getproductcriteria","deprecated":false},{"title":"/criterias/search-requests","summary":"Get search request criteria","prefix":{"name":"get","color":"get"},"badges":[{"name":"Customers","color":"purple"}],"link":"/criterias/listsearchrequestcriteria","deprecated":false},{"title":"/criterias/zone-list","summary":"Get zone list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/criterias/getzonelist","deprecated":false},{"title":"/criterias/categories/{categoryId}","summary":"Get criteria by category","prefix":{"name":"get","color":"get"},"badges":[],"link":"/criterias/getcriteriabycategory","deprecated":false}]}]}]}]}},{"type":"group","label":"Customers","link":"/openapi/customers","routeSlug":"/openapi/customers","items":[{"label":"Create a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/createcustomer","routeSlug":"/openapi/customers/createcustomer","metadata":{"seo":{"title":"Create a customer","description":"Creates a new customer.Requires SITE_CUSTOMER:WRITE permission and RS:CUSTOMER_CREATE right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomer","name":"Create a customer","isWebhook":false,"pointer":"/paths/~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a customer","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:CUSTOMER_CREATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate handling:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system checks for duplicates by "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email OR phones"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (any match on the same site)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"check_duplicate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": if a duplicate is found, the existing customer is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"silently"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the provided data and its ID is returned (HTTP 201)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"check_duplicate: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": returns HTTP 409 if a duplicate is found."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCustomerRequest"}},"schemaId":"components/schemas/CreateCustomerRequest","pointer":"/paths/~1customers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCustomerRequest"}},"responseCodes":["201","403","409","422"],"pointer":"/customers","href":"customers/createcustomer","openApiOperationId":"createCustomer","summary":"Create a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/CreateCustomerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCustomerRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Customer created (or updated if duplicate found without checkDuplicate)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_88","exampleIds":["paths/~1customers/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_88","exampleIds":["paths/~1customers/post/responses/201/content/application~1json/example"]},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate customer detected (only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checkDuplicate: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1customers/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1customers/post/responses/409/content/application~1json/example"]},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_88","exampleIds":["paths/~1customers/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_88","exampleIds":["paths/~1customers/post/responses/201/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1customers/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1customers/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/createcustomer"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/customers"},{"label":"Search customers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/searchcustomers","routeSlug":"/openapi/customers/searchcustomers","metadata":{"seo":{"title":"Search customers","description":"Searches customers with cursor-based pagination.Requires SITE_CUSTOMER:READ permission and RS:CUSTOMER_SEARCH right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchCustomers","name":"Search customers","isWebhook":false,"pointer":"/paths/~1customers~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search customers","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches customers with cursor-based pagination."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:CUSTOMER_SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are ordered by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customers_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" descending (most recent first)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchCustomerRequest","exampleIds":["paths/~1customers~1search/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SearchCustomerRequest","exampleIds":["paths/~1customers~1search/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1customers~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers/search","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchCustomerRequest","exampleIds":["paths/~1customers~1search/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","403"],"pointer":"/customers/search","href":"customers/searchcustomers","openApiOperationId":"searchCustomers","summary":"Search customers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/SearchCustomerRequest","exampleIds":["paths/~1customers~1search/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchCustomerRequest","exampleIds":["paths/~1customers~1search/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated search results","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_89"}},"schemaId":"schema_89"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1customers~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_89","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_89"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/searchcustomers"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/customers/search"},{"label":"List customer groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/listcustomergroups","routeSlug":"/openapi/customers/listcustomergroups","metadata":{"seo":{"title":"List customer groups","description":"Returns all available customer groups for the site.Requires SITE_CUSTOMER:READ permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomerGroups","name":"List customer groups","isWebhook":false,"pointer":"/paths/~1customers~1groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List customer groups","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all available customer groups for the site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Groups categorize customers (e.g. \"Demandeur\", \"Propriétaire\", \"Locataire\")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use group IDs when creating customers or leads."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/groups","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/customers/groups","href":"customers/listcustomergroups","openApiOperationId":"listCustomerGroups","summary":"List customer groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of groups","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_90","exampleIds":["paths/~1customers~1groups/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_90","exampleIds":["paths/~1customers~1groups/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1customers~1groups/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_90","exampleIds":["paths/~1customers~1groups/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_90","exampleIds":["paths/~1customers~1groups/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/listcustomergroups"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/customers/groups"},{"label":"List customer origins","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/listcustomerorigins","routeSlug":"/openapi/customers/listcustomerorigins","metadata":{"seo":{"title":"List customer origins","description":"Returns all available customer origins for the site.Requires SITE_CUSTOMER:READ permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomerOrigins","name":"List customer origins","isWebhook":false,"pointer":"/paths/~1customers~1origins/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List customer origins","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all available customer origins for the site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Origins track how a customer entered the system (e.g. \"Site internet\", \"Portail\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Recommandation\"). Use origin IDs when creating customers or leads."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/origins","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/customers/origins","href":"customers/listcustomerorigins","openApiOperationId":"listCustomerOrigins","summary":"List customer origins"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of origins","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_91","exampleIds":["paths/~1customers~1origins/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_91","exampleIds":["paths/~1customers~1origins/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1customers~1origins/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_91","exampleIds":["paths/~1customers~1origins/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_91","exampleIds":["paths/~1customers~1origins/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/listcustomerorigins"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/customers/origins"},{"label":"Get a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/getcustomer","routeSlug":"/openapi/customers/getcustomer","metadata":{"seo":{"title":"Get a customer","description":"Returns detailed customer information.Requires SITE_CUSTOMER:READ permission and RS:CUSTOMER_GET right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomer","name":"Get a customer","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a customer","badges":[{"name":"Customers","color":"purple"},{"name":"Properties","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns detailed customer information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:CUSTOMER_GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to load additional relations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available includes:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"origin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stopSms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"searchRequests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mandate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"website"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_78","description":"Unique identifier of the customer.","required":true,"example":789}],"pointer":"/paths/~1customers~1{customerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_79","description":"Comma-separated list of relations to include in the response.\nEach include triggers additional data loading.\n","example":"address,groups,origin,user"}],"pointer":"/paths/~1customers~1{customerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{customerId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":789,"schemaId":"schema_78"}],"query":[{"name":"include","in":"query","required":false,"example":"address,groups,origin,user","schemaId":"schema_79"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/customers/{customerId}","href":"customers/getcustomer","openApiOperationId":"getCustomer","summary":"Get a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Customer details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_92"}},"schemaId":"schema_92"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1customers~1{customerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_92","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_92"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/getcustomer"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"},{"name":"Properties","color":"green"}],"httpPath":"/customers/{customerId}"},{"label":"Update a customer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/updatecustomer","routeSlug":"/openapi/customers/updatecustomer","metadata":{"seo":{"title":"Update a customer","description":"Partially updates a customer. Only provided fields are modified.Requires SITE_CUSTOMER:WRITE permission and RS:CUSTOMER_UPDATE right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomer","name":"Update a customer","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a customer","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates a customer. Only provided fields are modified."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:CUSTOMER_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_78","description":"Unique identifier of the customer to update.","required":true,"example":789}],"pointer":"/paths/~1customers~1{customerId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomerRequest"}},"schemaId":"components/schemas/UpdateCustomerRequest","pointer":"/paths/~1customers~1{customerId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/customers/{customerId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":789,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCustomerRequest"}},"responseCodes":["204","403","404","422"],"pointer":"/customers/{customerId}","href":"customers/updatecustomer","openApiOperationId":"updateCustomer","summary":"Update a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/UpdateCustomerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomerRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Updated successfully"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1customers~1{customerId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/updatecustomer"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/customers/{customerId}"},{"label":"Create or update cold-calling consent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/upsertcustomerconsent","routeSlug":"/openapi/customers/upsertcustomerconsent","metadata":{"seo":{"title":"Create or update cold-calling consent","description":"Creates or updates the cold-calling consent (consentement anti-démarchage)for a customer.Requires SITE_CUSTOMER:WRITE permission and RS:CUSTOMER_UPDATE right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertCustomerConsent","name":"Create or update cold-calling consent","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1consent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update cold-calling consent","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates or updates the cold-calling consent (consentement anti-démarchage)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for a customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:CUSTOMER_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One consent record per customer (upsert)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the customer previously had their consent revoked, calling this endpoint"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reactivates it (clears the revocation date)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof files ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"proofs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are uploaded to the customer's cloud storage under"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Documents confidentiels/Consentement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subfolder."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when uploading proof files,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no files are attached."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_78","description":"Unique identifier of the customer.","required":true,"example":789}],"pointer":"/paths/~1customers~1{customerId}~1consent/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data","application/json"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/UpdateCustomerConsentRequest"},"application/json":{"schemaId":"components/schemas/UpdateCustomerConsentRequest"}},"schemaId":"components/schemas/UpdateCustomerConsentRequest","pointer":"/paths/~1customers~1{customerId}~1consent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers/{customerId}/consent","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":789,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/UpdateCustomerConsentRequest"},"application/json":{"schemaId":"components/schemas/UpdateCustomerConsentRequest"}},"responseCodes":["204","403","404","422"],"pointer":"/customers/{customerId}/consent","href":"customers/upsertcustomerconsent","openApiOperationId":"upsertCustomerConsent","summary":"Create or update cold-calling consent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/UpdateCustomerConsentRequest","mediaTypes":["multipart/form-data","application/json"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/UpdateCustomerConsentRequest"},"application/json":{"schemaId":"components/schemas/UpdateCustomerConsentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Consent created or updated successfully"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1customers~1{customerId}~1consent/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/upsertcustomerconsent"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/customers/{customerId}/consent"},{"label":"Revoke cold-calling consent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/revokecustomerconsent","routeSlug":"/openapi/customers/revokecustomerconsent","metadata":{"seo":{"title":"Revoke cold-calling consent","description":"Revokes the cold-calling consent for a customer.Requires SITE_CUSTOMER:WRITE permission and RS:CUSTOMER_UPDATE right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"revokeCustomerConsent","name":"Revoke cold-calling consent","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1consent/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke cold-calling consent","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revokes the cold-calling consent for a customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:CUSTOMER_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets a revocation date on the consent record."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes all associated proof files from storage."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no consent exists, the operation still returns 204."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_78","description":"Unique identifier of the customer.","required":true,"example":789}],"pointer":"/paths/~1customers~1{customerId}~1consent/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/customers/{customerId}/consent","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":789,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["204","403"],"pointer":"/customers/{customerId}/consent","href":"customers/revokecustomerconsent","openApiOperationId":"revokeCustomerConsent","summary":"Revoke cold-calling consent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Consent revoked successfully"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1customers~1{customerId}~1consent/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/revokecustomerconsent"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/customers/{customerId}/consent"},{"label":"Create a search request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/createsearchrequest","routeSlug":"/openapi/customers/createsearchrequest","metadata":{"seo":{"title":"Create a search request","description":"Creates a search request for a customer with criteria.Requires SITE_CUSTOMER:WRITE permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSearchRequest","name":"Create a search request","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1search-requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a search request","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a search request for a customer with criteria."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search requests define what a buyer/tenant is looking for. When active, the system"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"runs automatic matching against new property listings."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_78","description":"ID of the customer to attach the search request to.","required":true,"example":789}],"pointer":"/paths/~1customers~1{customerId}~1search-requests/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSearchRequestBody"}},"schemaId":"components/schemas/CreateSearchRequestBody","pointer":"/paths/~1customers~1{customerId}~1search-requests/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers/{customerId}/search-requests","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":789,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSearchRequestBody"}},"responseCodes":["201","403","422"],"pointer":"/customers/{customerId}/search-requests","href":"customers/createsearchrequest","openApiOperationId":"createSearchRequest","summary":"Create a search request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/CreateSearchRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSearchRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Search request created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_93","exampleIds":["paths/~1customers~1{customerId}~1search-requests/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_93","exampleIds":["paths/~1customers~1{customerId}~1search-requests/post/responses/201/content/application~1json/example"]},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1customers~1{customerId}~1search-requests/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_93","exampleIds":["paths/~1customers~1{customerId}~1search-requests/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_93","exampleIds":["paths/~1customers~1{customerId}~1search-requests/post/responses/201/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/createsearchrequest"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/customers/{customerId}/search-requests"},{"label":"Update a search request","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/updatesearchrequest","routeSlug":"/openapi/customers/updatesearchrequest","metadata":{"seo":{"title":"Update a search request","description":"Partially updates a search request for a customer.Requires SITE_CUSTOMER:WRITE permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSearchRequest","name":"Update a search request","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1search-requests~1{searchRequestId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a search request","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates a search request for a customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only provided fields are modified. Criteria are replaced entirely when provided"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(not merged with existing ones)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_78","description":"ID of the customer.","required":true,"example":789},{"name":"searchRequestId","in":"path","schemaId":"schema_78","description":"ID of the search request to update.","required":true,"example":42}],"pointer":"/paths/~1customers~1{customerId}~1search-requests~1{searchRequestId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSearchRequestBody"}},"schemaId":"components/schemas/UpdateSearchRequestBody","pointer":"/paths/~1customers~1{customerId}~1search-requests~1{searchRequestId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/customers/{customerId}/search-requests/{searchRequestId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":789,"schemaId":"schema_78"},{"name":"searchRequestId","in":"path","required":true,"example":42,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateSearchRequestBody"}},"responseCodes":["204","400","403","422"],"pointer":"/customers/{customerId}/search-requests/{searchRequestId}","href":"customers/updatesearchrequest","openApiOperationId":"updateSearchRequest","summary":"Update a search request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/UpdateSearchRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateSearchRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Search request updated"},{"code":"400","description":"Invalid criteria"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1customers~1{customerId}~1search-requests~1{searchRequestId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/updatesearchrequest"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/customers/{customerId}/search-requests/{searchRequestId}"},{"label":"List follow-ups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/listcustomerfollowups","routeSlug":"/openapi/customers/listcustomerfollowups","metadata":{"seo":{"title":"List follow-ups","description":"Returns paginated follow-ups (rapprochements) for a customer.Requires SITE_CUSTOMER:READ permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomerFollowUps","name":"List follow-ups","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1follow-ups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List follow-ups","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns paginated follow-ups (rapprochements) for a customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A follow-up links a customer to a product they are interested in,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tracking the progression of the relationship."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_78","description":"ID of the customer.","required":true,"example":789}],"pointer":"/paths/~1customers~1{customerId}~1follow-ups/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"per_page","in":"query","schemaId":"schema_94","description":"Number of results per page. Maximum 200, default 25.\n","example":50}],"pointer":"/paths/~1customers~1{customerId}~1follow-ups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{customerId}/follow-ups","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":789,"schemaId":"schema_78"}],"query":[{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_94"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/customers/{customerId}/follow-ups","href":"customers/listcustomerfollowups","openApiOperationId":"listCustomerFollowUps","summary":"List follow-ups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of follow-ups","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_95"}},"schemaId":"schema_95"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1customers~1{customerId}~1follow-ups/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_95","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_95"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/listcustomerfollowups"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/customers/{customerId}/follow-ups"},{"label":"Create a follow-up","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/createcustomerfollowup","routeSlug":"/openapi/customers/createcustomerfollowup","metadata":{"seo":{"title":"Create a follow-up","description":"Creates a follow-up linking a customer to a product.Returns 409 if the follow-up already exists (customer already follows this product).Requires SITE_CUSTOMER:WRITE permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomerFollowUp","name":"Create a follow-up","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1follow-ups~1{productId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a follow-up","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a follow-up linking a customer to a product."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 409 if the follow-up already exists (customer already follows this product)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_78","description":"ID of the customer.","required":true,"example":789},{"name":"productId","in":"path","schemaId":"schema_78","description":"ID of the product to follow.","required":true,"example":12345}],"pointer":"/paths/~1customers~1{customerId}~1follow-ups~1{productId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers/{customerId}/follow-ups/{productId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":789,"schemaId":"schema_78"},{"name":"productId","in":"path","required":true,"example":12345,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["201","403","409"],"pointer":"/customers/{customerId}/follow-ups/{productId}","href":"customers/createcustomerfollowup","openApiOperationId":"createCustomerFollowUp","summary":"Create a follow-up"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Follow-up created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_96"}},"schemaId":"schema_96"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":"Follow-up already exists (customer already linked to this product)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_96"}},"schemaId":"schema_96"}],"pointer":"/paths/~1customers~1{customerId}~1follow-ups~1{productId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_96","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_96"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"schema_96","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_96"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/createcustomerfollowup"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/customers/{customerId}/follow-ups/{productId}"},{"label":"Update a follow-up","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/updatecustomerfollowup","routeSlug":"/openapi/customers/updatecustomerfollowup","metadata":{"seo":{"title":"Update a follow-up","description":"Updates a follow-up (e.g. rating).Requires SITE_CUSTOMER:WRITE permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomerFollowUp","name":"Update a follow-up","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1follow-ups~1{productId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a follow-up","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a follow-up (e.g. rating)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_78","description":"ID of the customer.","required":true,"example":789},{"name":"productId","in":"path","schemaId":"schema_78","description":"ID of the followed product.","required":true,"example":12345}],"pointer":"/paths/~1customers~1{customerId}~1follow-ups~1{productId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateFollowUpRequest","exampleIds":["paths/~1customers~1{customerId}~1follow-ups~1{productId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateFollowUpRequest","exampleIds":["paths/~1customers~1{customerId}~1follow-ups~1{productId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1customers~1{customerId}~1follow-ups~1{productId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/customers/{customerId}/follow-ups/{productId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":789,"schemaId":"schema_78"},{"name":"productId","in":"path","required":true,"example":12345,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateFollowUpRequest","exampleIds":["paths/~1customers~1{customerId}~1follow-ups~1{productId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","403"],"pointer":"/customers/{customerId}/follow-ups/{productId}","href":"customers/updatecustomerfollowup","openApiOperationId":"updateCustomerFollowUp","summary":"Update a follow-up"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/UpdateFollowUpRequest","exampleIds":["paths/~1customers~1{customerId}~1follow-ups~1{productId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateFollowUpRequest","exampleIds":["paths/~1customers~1{customerId}~1follow-ups~1{productId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Follow-up updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_96"}},"schemaId":"schema_96"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1customers~1{customerId}~1follow-ups~1{productId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_96","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_96"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/updatecustomerfollowup"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/customers/{customerId}/follow-ups/{productId}"},{"label":"Delete a follow-up","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/deletecustomerfollowup","routeSlug":"/openapi/customers/deletecustomerfollowup","metadata":{"seo":{"title":"Delete a follow-up","description":"Removes a follow-up between a customer and a product.Requires SITE_CUSTOMER:WRITE permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomerFollowUp","name":"Delete a follow-up","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1follow-ups~1{productId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a follow-up","badges":[{"name":"Customers","color":"purple"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes a follow-up between a customer and a product."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_78","description":"ID of the customer.","required":true,"example":789},{"name":"productId","in":"path","schemaId":"schema_78","description":"ID of the product to unfollow.","required":true,"example":12345}],"pointer":"/paths/~1customers~1{customerId}~1follow-ups~1{productId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/customers/{customerId}/follow-ups/{productId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":789,"schemaId":"schema_78"},{"name":"productId","in":"path","required":true,"example":12345,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["204","403"],"pointer":"/customers/{customerId}/follow-ups/{productId}","href":"customers/deletecustomerfollowup","openApiOperationId":"deleteCustomerFollowUp","summary":"Delete a follow-up"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Follow-up deleted"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1customers~1{customerId}~1follow-ups~1{productId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/deletecustomerfollowup"}],"panels":[]}]},"badges":[{"name":"Customers","color":"purple"}],"httpPath":"/customers/{customerId}/follow-ups/{productId}"},{"label":"List actions for a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/listcustomeractions","routeSlug":"/openapi/customers/listcustomeractions","metadata":{"seo":{"title":"List actions for a customer","description":"Returns paginated action history for a customer.Requires SITE_CUSTOMER:READ permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomerActions","name":"List actions for a customer","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1actions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List actions for a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns paginated action history for a customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actions are commercial activities logged on a customer (calls, visits,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"emails, etc.). Uses offset-based pagination with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_78","description":"ID of the customer.","required":true,"example":789}],"pointer":"/paths/~1customers~1{customerId}~1actions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_97","description":"Offset for pagination (number of items to skip). Default 0.\n","example":0}],"pointer":"/paths/~1customers~1{customerId}~1actions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/customers/{customerId}/actions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":789,"schemaId":"schema_78"}],"query":[{"name":"cursor","in":"query","required":false,"example":0,"schemaId":"schema_97"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/customers/{customerId}/actions","href":"customers/listcustomeractions","openApiOperationId":"listCustomerActions","summary":"List actions for a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of actions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_98"}},"schemaId":"schema_98"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1customers~1{customerId}~1actions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_98","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_98"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/listcustomeractions"}],"panels":[]}]},"httpPath":"/customers/{customerId}/actions"},{"label":"Create an action for a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/customers/createcustomeraction","routeSlug":"/openapi/customers/createcustomeraction","metadata":{"seo":{"title":"Create an action for a customer","description":"Logs a new commercial action on a customer record.Requires SITE_CUSTOMER:WRITE permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomerAction","name":"Create an action for a customer","isWebhook":false,"pointer":"/paths/~1customers~1{customerId}~1actions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an action for a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Logs a new commercial action on a customer record."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CUSTOMER:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The action is always recorded in the application journal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, it will only appear in the customer's action history tab if the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"action type has child actions configured for the site. This depends on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the agency's action workflow configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /actions/types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list available action types and check which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ones have child actions configured."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_78","description":"ID of the customer.","required":true,"example":789}],"pointer":"/paths/~1customers~1{customerId}~1actions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_99","exampleIds":["paths/~1customers~1{customerId}~1actions/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_99","exampleIds":["paths/~1customers~1{customerId}~1actions/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1customers~1{customerId}~1actions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/customers/{customerId}/actions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":789,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_99","exampleIds":["paths/~1customers~1{customerId}~1actions/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","403","404","422"],"pointer":"/customers/{customerId}/actions","href":"customers/createcustomeraction","openApiOperationId":"createCustomerAction","summary":"Create an action for a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"schema_99","exampleIds":["paths/~1customers~1{customerId}~1actions/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_99","exampleIds":["paths/~1customers~1{customerId}~1actions/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Action created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100","exampleIds":["paths/~1customers~1{customerId}~1actions/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_100","exampleIds":["paths/~1customers~1{customerId}~1actions/post/responses/201/content/application~1json/example"]},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1customers~1{customerId}~1actions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_100","exampleIds":["paths/~1customers~1{customerId}~1actions/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100","exampleIds":["paths/~1customers~1{customerId}~1actions/post/responses/201/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/createcustomeraction"}],"panels":[]}]},"httpPath":"/customers/{customerId}/actions"}],"content":{"contentType":"group","meta":{"name":"Customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact management — details, search, groups, origins, consent, follow-ups, and actions."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/customers","summary":"Create a customer","prefix":{"name":"post","color":"post"},"badges":[{"name":"Customers","color":"purple"}],"link":"/customers/createcustomer","deprecated":false},{"title":"/customers/search","summary":"Search customers","prefix":{"name":"post","color":"post"},"badges":[{"name":"Customers","color":"purple"}],"link":"/customers/searchcustomers","deprecated":false},{"title":"/customers/groups","summary":"List customer groups","prefix":{"name":"get","color":"get"},"badges":[{"name":"Customers","color":"purple"}],"link":"/customers/listcustomergroups","deprecated":false},{"title":"/customers/origins","summary":"List customer origins","prefix":{"name":"get","color":"get"},"badges":[{"name":"Customers","color":"purple"}],"link":"/customers/listcustomerorigins","deprecated":false},{"title":"/customers/{customerId}","summary":"Get a customer","prefix":{"name":"get","color":"get"},"badges":[{"name":"Customers","color":"purple"},{"name":"Properties","color":"green"}],"link":"/customers/getcustomer","deprecated":false},{"title":"/customers/{customerId}","summary":"Update a customer","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Customers","color":"purple"}],"link":"/customers/updatecustomer","deprecated":false},{"title":"/customers/{customerId}/consent","summary":"Create or update cold-calling consent","prefix":{"name":"post","color":"post"},"badges":[{"name":"Customers","color":"purple"}],"link":"/customers/upsertcustomerconsent","deprecated":false},{"title":"/customers/{customerId}/consent","summary":"Revoke cold-calling consent","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Customers","color":"purple"}],"link":"/customers/revokecustomerconsent","deprecated":false},{"title":"/customers/{customerId}/search-requests","summary":"Create a search request","prefix":{"name":"post","color":"post"},"badges":[{"name":"Customers","color":"purple"}],"link":"/customers/createsearchrequest","deprecated":false},{"title":"/customers/{customerId}/search-requests/{searchRequestId}","summary":"Update a search request","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Customers","color":"purple"}],"link":"/customers/updatesearchrequest","deprecated":false},{"title":"/customers/{customerId}/follow-ups","summary":"List follow-ups","prefix":{"name":"get","color":"get"},"badges":[{"name":"Customers","color":"purple"}],"link":"/customers/listcustomerfollowups","deprecated":false},{"title":"/customers/{customerId}/follow-ups/{productId}","summary":"Create a follow-up","prefix":{"name":"post","color":"post"},"badges":[{"name":"Customers","color":"purple"}],"link":"/customers/createcustomerfollowup","deprecated":false},{"title":"/customers/{customerId}/follow-ups/{productId}","summary":"Update a follow-up","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Customers","color":"purple"}],"link":"/customers/updatecustomerfollowup","deprecated":false},{"title":"/customers/{customerId}/follow-ups/{productId}","summary":"Delete a follow-up","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Customers","color":"purple"}],"link":"/customers/deletecustomerfollowup","deprecated":false},{"title":"/customers/{customerId}/actions","summary":"List actions for a customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/listcustomeractions","deprecated":false},{"title":"/customers/{customerId}/actions","summary":"Create an action for a customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/createcustomeraction","deprecated":false}]}]}]}]}},{"type":"group","label":"Leads","link":"/openapi/leads","routeSlug":"/openapi/leads","items":[{"label":"Create a seller lead","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/leads/createsellerlead","routeSlug":"/openapi/leads/createsellerlead","metadata":{"seo":{"title":"Create a seller lead","description":"Creates a seller lead with a customer and a product.Requires SITE_LEADS permission and RS:LEADS_SELLER right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSellerLead","name":"Create a seller lead","isWebhook":false,"pointer":"/paths/~1leads~1sellers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a seller lead","badges":[{"name":"Leads","color":"orange"},{"name":"Websites","color":"blueberry"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a seller lead with a customer and a product."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_LEADS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:LEADS_SELLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Synchronization & duplicate behavior:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system automatically checks for duplicate customers by email OR phone OR mobile_phone."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"check_duplicate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): if a duplicate is found, the existing contact"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"silently updated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the provided data and linked to the product."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the existing one."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"check_duplicate: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": returns HTTP 409 with error code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"duplicate is found. You must then decide to proceed without the flag or skip."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer address:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Include address fields directly in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postalcode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"latitude"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"longitude"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These are persisted on the contact record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product creation:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided, a product is created from"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. Criteria follow the same rules as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts either the XML key (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"TypeBien\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or the numeric ID (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"27\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format depends on criteria type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DPE is auto-calculated from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conso_energ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valeur_GES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if letters are not provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GPS is auto-geocoded from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Adresse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CodePostal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ville"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Alentour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User assignment:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted, the system uses the configured"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lead distribution rule ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEFAULT_LEADS_AFFECTATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to automatically assign"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a user within the target agency."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSellerLeadRequest","exampleIds":["paths/~1leads~1sellers/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateSellerLeadRequest","exampleIds":["paths/~1leads~1sellers/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1sellers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/sellers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateSellerLeadRequest","exampleIds":["paths/~1leads~1sellers/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","403","409","422"],"pointer":"/leads/sellers","href":"leads/createsellerlead","openApiOperationId":"createSellerLead","summary":"Create a seller lead"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/CreateSellerLeadRequest","exampleIds":["paths/~1leads~1sellers/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateSellerLeadRequest","exampleIds":["paths/~1leads~1sellers/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Lead created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101","exampleIds":["paths/~1leads~1sellers/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_101","exampleIds":["paths/~1leads~1sellers/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid criteria. Returned when a criteria value is not recognized.\nResponse body contains the invalid criteria details.\n"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate customer detected (only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"check_duplicate: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The existing customer was found but not updated."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1leads~1sellers/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1leads~1sellers/post/responses/409/content/application~1json/example"]},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1leads~1sellers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_101","exampleIds":["paths/~1leads~1sellers/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101","exampleIds":["paths/~1leads~1sellers/post/responses/201/content/application~1json/example"]}}},{"code":"400"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1leads~1sellers/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1leads~1sellers/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/leads/createsellerlead"}],"panels":[]}]},"badges":[{"name":"Leads","color":"orange"},{"name":"Websites","color":"blueberry"}],"httpPath":"/leads/sellers"},{"label":"Create a buyer lead","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/leads/createbuyerlead","routeSlug":"/openapi/leads/createbuyerlead","metadata":{"seo":{"title":"Create a buyer lead","description":"Creates a buyer lead with a customer and optional search requests.Requires SITE_LEADS permission and RS:LEADS_BUYER right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBuyerLead","name":"Create a buyer lead","isWebhook":false,"pointer":"/paths/~1leads~1buyers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a buyer lead","badges":[{"name":"Leads","color":"orange"},{"name":"Websites","color":"blueberry"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a buyer lead with a customer and optional search requests."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_LEADS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:LEADS_BUYER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Synchronization & duplicate behavior:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Same as seller leads (see above)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search requests:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Each search request contains criteria with operators:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EGAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Equals (exact match)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPERIEUR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Greater than or equal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFERIEUR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Less than or equal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTIENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Contains (for text/multi-value, e.g. zones)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DIFFERENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Not equal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criterias/search-requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover available search criteria for your site."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer address:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Include address fields directly in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"postalcode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"latitude"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"longitude"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User assignment:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Same auto-assignment logic as seller leads when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBuyerLeadRequest","exampleIds":["paths/~1leads~1buyers/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateBuyerLeadRequest","exampleIds":["paths/~1leads~1buyers/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1buyers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/buyers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateBuyerLeadRequest","exampleIds":["paths/~1leads~1buyers/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","403","409","422"],"pointer":"/leads/buyers","href":"leads/createbuyerlead","openApiOperationId":"createBuyerLead","summary":"Create a buyer lead"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/CreateBuyerLeadRequest","exampleIds":["paths/~1leads~1buyers/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBuyerLeadRequest","exampleIds":["paths/~1leads~1buyers/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Lead created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_102","exampleIds":["paths/~1leads~1buyers/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_102","exampleIds":["paths/~1leads~1buyers/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid criteria in search request. Returned when a criteria value\nis not recognized. Response body contains the invalid criteria details.\n"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate customer detected (only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"check_duplicate: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1leads~1buyers/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1leads~1buyers/post/responses/409/content/application~1json/example"]},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1leads~1buyers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_102","exampleIds":["paths/~1leads~1buyers/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_102","exampleIds":["paths/~1leads~1buyers/post/responses/201/content/application~1json/example"]}}},{"code":"400"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1leads~1buyers/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1leads~1buyers/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/leads/createbuyerlead"}],"panels":[]}]},"badges":[{"name":"Leads","color":"orange"},{"name":"Websites","color":"blueberry"}],"httpPath":"/leads/buyers"}],"content":{"contentType":"group","meta":{"name":"Leads"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Leads","showPageActions":true},{"nodeType":"markdoc","content":"Seller and buyer lead creation from external tools."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/leads/sellers","summary":"Create a seller lead","prefix":{"name":"post","color":"post"},"badges":[{"name":"Leads","color":"orange"},{"name":"Websites","color":"blueberry"}],"link":"/leads/createsellerlead","deprecated":false},{"title":"/leads/buyers","summary":"Create a buyer lead","prefix":{"name":"post","color":"post"},"badges":[{"name":"Leads","color":"orange"},{"name":"Websites","color":"blueberry"}],"link":"/leads/createbuyerlead","deprecated":false}]}]}]}]}},{"type":"group","label":"Transactions","link":"/openapi/transactions","routeSlug":"/openapi/transactions","items":[{"label":"Search sale agreements","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/transactions/searchsaleagreements","routeSlug":"/openapi/transactions/searchsaleagreements","metadata":{"seo":{"title":"Search sale agreements","description":"Searches sale agreements (compromis de vente) with cursor-based pagination.Requires SITE_PRODUCT:READ permission and RS:COMPROMIS_SEARCH right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchSaleAgreements","name":"Search sale agreements","isWebhook":false,"pointer":"/paths/~1transactions~1agreement~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search sale agreements","badges":[{"name":"Sales","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches sale agreements (compromis de vente) with cursor-based pagination."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_PRODUCT:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:COMPROMIS_SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use cases:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all sales completed after a given date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find a sale agreement by product reference or customer name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export sales data for valuation reports (avis de valeur)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key response fields for sale tracking:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — actual buyer price (price including agency fees)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — property net price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date_act"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — deed signing date (= effective sale date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date_agreement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — compromise signature date"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to load additional relations (buyer, seller, fees, agencies, etc.)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available includes: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compromis_cs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_origin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_informations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_extended"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_relations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller_origin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller_admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"followed_nego"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recommandation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fees_nego"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"analytic"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1agreement~1search/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1agreement~1search/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1transactions~1agreement~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/agreement/search","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1agreement~1search/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","403","422"],"pointer":"/transactions/agreement/search","href":"transactions/searchsaleagreements","openApiOperationId":"searchSaleAgreements","summary":"Search sale agreements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1agreement~1search/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1agreement~1search/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of sale agreements","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103"}},"schemaId":"schema_103"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1transactions~1agreement~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_103","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/searchsaleagreements"}],"panels":[]}]},"badges":[{"name":"Sales","color":"red"}],"httpPath":"/transactions/agreement/search"},{"label":"Search sales offers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/transactions/searchsalesoffers","routeSlug":"/openapi/transactions/searchsalesoffers","metadata":{"seo":{"title":"Search sales offers","description":"Searches sales offers (offres d'achat) with cursor-based pagination.Requires SITE_PRODUCT:READ permission and RS:OFFER_SEARCH right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchSalesOffers","name":"Search sales offers","isWebhook":false,"pointer":"/paths/~1transactions~1sales-offers~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search sales offers","badges":[{"name":"Sales","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches sales offers (offres d'achat) with cursor-based pagination."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_PRODUCT:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:OFFER_SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offers have an additional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offer_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicating the current state"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the offer ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attente"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"acceptee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refusee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"annulee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1sales-offers~1search/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1sales-offers~1search/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1transactions~1sales-offers~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/sales-offers/search","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1sales-offers~1search/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","403","422"],"pointer":"/transactions/sales-offers/search","href":"transactions/searchsalesoffers","openApiOperationId":"searchSalesOffers","summary":"Search sales offers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1sales-offers~1search/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1sales-offers~1search/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of sales offers","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103"}},"schemaId":"schema_103"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1transactions~1sales-offers~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_103","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/searchsalesoffers"}],"panels":[]}]},"badges":[{"name":"Sales","color":"red"}],"httpPath":"/transactions/sales-offers/search"},{"label":"Search leases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/transactions/searchleases","routeSlug":"/openapi/transactions/searchleases","metadata":{"seo":{"title":"Search leases","description":"Searches lease agreements (baux de location) with cursor-based pagination.Requires SITE_PRODUCT:READ permission and RS:LEASE_SEARCH right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchLeases","name":"Search leases","isWebhook":false,"pointer":"/paths/~1transactions~1leases~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search leases","badges":[{"name":"Sales","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches lease agreements (baux de location) with cursor-based pagination."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_PRODUCT:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:LEASE_SEARCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1leases~1search/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1leases~1search/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1transactions~1leases~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transactions/leases/search","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1leases~1search/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","403","422"],"pointer":"/transactions/leases/search","href":"transactions/searchleases","openApiOperationId":"searchLeases","summary":"Search leases"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1leases~1search/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchTransactionRequest","exampleIds":["paths/~1transactions~1leases~1search/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of leases","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103"}},"schemaId":"schema_103"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1transactions~1leases~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_103","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_103"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/searchleases"}],"panels":[]}]},"badges":[{"name":"Sales","color":"red"}],"httpPath":"/transactions/leases/search"},{"label":"Get a sale transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/transactions/getsaletransaction","routeSlug":"/openapi/transactions/getsaletransaction","metadata":{"seo":{"title":"Get a sale transaction","description":"Returns detailed information about a sale transaction (compromis, offer, or lease).Requires SITE_PRODUCT:READ permission and RS:COMPROMIS_GET right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSaleTransaction","name":"Get a sale transaction","isWebhook":false,"pointer":"/paths/~1agreement~1{compromisId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a sale transaction","badges":[{"name":"Sales","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns detailed information about a sale transaction (compromis, offer, or lease)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_PRODUCT:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:COMPROMIS_GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to load additional relations. Available includes:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"compromis_cs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_origin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_informations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_extended"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_relations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller_address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller_origin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seller_admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"followed_nego"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recommandation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fees_nego"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"analytic"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"compromisId","in":"path","schemaId":"schema_78","description":"Unique identifier of the sale transaction (compromis).","required":true,"example":5678}],"pointer":"/paths/~1agreement~1{compromisId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_79","description":"Comma-separated list of relations to include in the response.\nEach include triggers additional eager loading on the server side.\n","example":"buyer,seller,fees,agencies"}],"pointer":"/paths/~1agreement~1{compromisId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/agreement/{compromisId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"compromisId","in":"path","required":true,"example":5678,"schemaId":"schema_78"}],"query":[{"name":"include","in":"query","required":false,"example":"buyer,seller,fees,agencies","schemaId":"schema_79"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/agreement/{compromisId}","href":"transactions/getsaletransaction","openApiOperationId":"getSaleTransaction","summary":"Get a sale transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sale transaction details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104","exampleIds":["paths/~1agreement~1{compromisId}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_104","exampleIds":["paths/~1agreement~1{compromisId}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1agreement~1{compromisId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_104","exampleIds":["paths/~1agreement~1{compromisId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_104","exampleIds":["paths/~1agreement~1{compromisId}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/getsaletransaction"}],"panels":[]}]},"badges":[{"name":"Sales","color":"red"}],"httpPath":"/agreement/{compromisId}"},{"label":"Update a sale transaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/transactions/updatesaletransaction","routeSlug":"/openapi/transactions/updatesaletransaction","metadata":{"seo":{"title":"Update a sale transaction","description":"Updates billing and invoicing fields on a sale transaction.Requires SITE_PRODUCT:WRITE permission and RS:COMPROMIS_UPDATE right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSaleTransaction","name":"Update a sale transaction","isWebhook":false,"pointer":"/paths/~1agreement~1{compromisId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a sale transaction","badges":[{"name":"Sales","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates billing and invoicing fields on a sale transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_PRODUCT:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:COMPROMIS_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important limitations:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint only accepts "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing/invoicing fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (conformity, payment, invoice numbers, fees)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It does "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allow updating: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date_act"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date_agreement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale price and deed date are set when the agreement is created in the back-office."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /agreement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint in the Site API context — sale agreements"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are created via the internal user interface or the User API."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Each fee entry must reference an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the transaction's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fee records and provide a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" between 0 and 100."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"compromisId","in":"path","schemaId":"schema_78","description":"Unique identifier of the sale transaction to update.","required":true,"example":5678}],"pointer":"/paths/~1agreement~1{compromisId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTransactionRequest","exampleIds":["paths/~1agreement~1{compromisId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateTransactionRequest","exampleIds":["paths/~1agreement~1{compromisId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1agreement~1{compromisId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/agreement/{compromisId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"compromisId","in":"path","required":true,"example":5678,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTransactionRequest","exampleIds":["paths/~1agreement~1{compromisId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","403","404","422"],"pointer":"/agreement/{compromisId}","href":"transactions/updatesaletransaction","openApiOperationId":"updateSaleTransaction","summary":"Update a sale transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/UpdateTransactionRequest","exampleIds":["paths/~1agreement~1{compromisId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTransactionRequest","exampleIds":["paths/~1agreement~1{compromisId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Updated successfully"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1agreement~1{compromisId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/updatesaletransaction"}],"panels":[]}]},"badges":[{"name":"Sales","color":"red"}],"httpPath":"/agreement/{compromisId}"}],"content":{"contentType":"group","meta":{"name":"Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":"Sales agreements, sales offers, and leases."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transactions/agreement/search","summary":"Search sale agreements","prefix":{"name":"post","color":"post"},"badges":[{"name":"Sales","color":"red"}],"link":"/transactions/searchsaleagreements","deprecated":false},{"title":"/transactions/sales-offers/search","summary":"Search sales offers","prefix":{"name":"post","color":"post"},"badges":[{"name":"Sales","color":"red"}],"link":"/transactions/searchsalesoffers","deprecated":false},{"title":"/transactions/leases/search","summary":"Search leases","prefix":{"name":"post","color":"post"},"badges":[{"name":"Sales","color":"red"}],"link":"/transactions/searchleases","deprecated":false},{"title":"/agreement/{compromisId}","summary":"Get a sale transaction","prefix":{"name":"get","color":"get"},"badges":[{"name":"Sales","color":"red"}],"link":"/transactions/getsaletransaction","deprecated":false},{"title":"/agreement/{compromisId}","summary":"Update a sale transaction","prefix":{"name":"put","color":"put"},"badges":[{"name":"Sales","color":"red"}],"link":"/transactions/updatesaletransaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/openapi/users","routeSlug":"/openapi/users","items":[{"label":"List users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/listusers","routeSlug":"/openapi/users/listusers","metadata":{"seo":{"title":"List users","description":"Returns all users (agents/collaborators) for the authenticated site,with optional filters and cursor-based pagination.Requires SITE_ADMIN:READ permission and RS:ADMIN_ALL right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUsers","name":"List users","isWebhook":false,"pointer":"/paths/~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List users","badges":[{"name":"Websites","color":"blueberry"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all users (agents/collaborators) for the authenticated site,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with optional filters and cursor-based pagination."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_ADMIN:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:ADMIN_ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" All query parameters are optional. Combine them to narrow results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Uses cursor-based pagination. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"previous response as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to fetch the next page."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"firstname","in":"query","schemaId":"schema_79","description":"Filter by first name (partial match).","example":"Jean"},{"name":"lastname","in":"query","schemaId":"schema_79","description":"Filter by last name (partial match).","example":"Dupont"},{"name":"email","in":"query","schemaId":"schema_79","description":"Filter by email (partial match).","example":"dupont@example.com"},{"name":"status","in":"query","schemaId":"schema_78","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by user status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Archived"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Hidden/deleted"},"children":[]}]}]}]}],"example":1},{"name":"without_deleted","in":"query","schemaId":"schema_105","description":"When true, excludes deleted/archived users from results.\nEquivalent to filtering out status 0 and 3.\n","example":true},{"name":"delegation","in":"query","schemaId":"schema_105","description":"Filter by delegation flag (users who can delegate their work)."},{"name":"agency_ids","in":"query","schemaId":"schema_106","description":"Filter by agency IDs. Only returns users attached to these agencies.\nEach ID must be within the authenticated site's scope.\n","example":[123,456]},{"name":"per_page","in":"query","schemaId":"schema_107","description":"Number of results per page. Maximum 200.\n","example":50},{"name":"telephone_code","in":"query","schemaId":"schema_105","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, phone numbers are formatted in international format"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+33601020304"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0601020304"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[{"name":"firstname","in":"query","required":false,"example":"Jean","schemaId":"schema_79"},{"name":"lastname","in":"query","required":false,"example":"Dupont","schemaId":"schema_79"},{"name":"email","in":"query","required":false,"example":"dupont@example.com","schemaId":"schema_79"},{"name":"status","in":"query","required":false,"example":1,"schemaId":"schema_78"},{"name":"without_deleted","in":"query","required":false,"example":true,"schemaId":"schema_105"},{"name":"delegation","in":"query","required":false,"schemaId":"schema_105"},{"name":"agency_ids","in":"query","required":false,"example":[123,456],"schemaId":"schema_106"},{"name":"per_page","in":"query","required":false,"example":50,"schemaId":"schema_107"},{"name":"telephone_code","in":"query","required":false,"example":true,"schemaId":"schema_105"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/users","href":"users/listusers","openApiOperationId":"listUsers","summary":"List users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of users","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108"}},"schemaId":"schema_108"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_108","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_108"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/listusers"}],"panels":[]}]},"badges":[{"name":"Websites","color":"blueberry"}],"httpPath":"/users"},{"label":"Create a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/createuser","routeSlug":"/openapi/users/createuser","metadata":{"seo":{"title":"Create a user","description":"Creates a new user (agent/collaborator) in the system.Requires SITE_ADMIN:WRITE permission and RS:ADMIN_CREATE right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUser","name":"Create a user","isWebhook":false,"pointer":"/paths/~1users/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a user","badges":[{"name":"Access"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new user (agent/collaborator) in the system."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_ADMIN:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:ADMIN_CREATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Password requirements (RGPD):"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length: 12-40 characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must contain: uppercase, lowercase, digit, special character"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agency assignment:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agency_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the user's primary agency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agencies_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to grant access to additional agencies."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User types:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /users/types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover available types"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. Négociateur, Gestionnaire, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Groups:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /users/groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover available groups"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(determines access level and permissions within the agency)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserRequest","exampleIds":["paths/~1users/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateUserRequest","exampleIds":["paths/~1users/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1users/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/users","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateUserRequest","exampleIds":["paths/~1users/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","403","422"],"pointer":"/users","href":"users/createuser","openApiOperationId":"createUser","summary":"Create a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/CreateUserRequest","exampleIds":["paths/~1users/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateUserRequest","exampleIds":["paths/~1users/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"User created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_109","exampleIds":["paths/~1users/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_109","exampleIds":["paths/~1users/post/responses/201/content/application~1json/example"]},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1users/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_109","exampleIds":["paths/~1users/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_109","exampleIds":["paths/~1users/post/responses/201/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/createuser"}],"panels":[]}]},"badges":[{"name":"Access"}],"httpPath":"/users"},{"label":"Get a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/getuser","routeSlug":"/openapi/users/getuser","metadata":{"seo":{"title":"Get a user","description":"Returns detailed information about a user (agent/collaborator).Requires SITE_ADMIN:READ permission and RS:ADMIN_GET right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUser","name":"Get a user","isWebhook":false,"pointer":"/paths/~1users~1{userId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a user","badges":[{"name":"Properties","color":"green"},{"name":"Customers","color":"purple"},{"name":"Websites","color":"blueberry"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns detailed information about a user (agent/collaborator)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_ADMIN:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:ADMIN_GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include=logs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include the user's recent action log entries."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_78","description":"Unique identifier of the user.","required":true,"example":582602}],"pointer":"/paths/~1users~1{userId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_79","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data to include. Currently available: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"logs"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(recent action log entries for this user)."},"children":[]}]}]}],"example":"logs"}],"pointer":"/paths/~1users~1{userId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{userId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":582602,"schemaId":"schema_78"}],"query":[{"name":"include","in":"query","required":false,"example":"logs","schemaId":"schema_79"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/users/{userId}","href":"users/getuser","openApiOperationId":"getUser","summary":"Get a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_110"}},"schemaId":"schema_110"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1users~1{userId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_110","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_110"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuser"}],"panels":[]}]},"badges":[{"name":"Properties","color":"green"},{"name":"Customers","color":"purple"},{"name":"Websites","color":"blueberry"}],"httpPath":"/users/{userId}"},{"label":"Update a user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/updateuser","routeSlug":"/openapi/users/updateuser","metadata":{"seo":{"title":"Update a user","description":"Partially updates a user. Only provided fields are modified.Requires SITE_ADMIN:WRITE permission and RS:ADMIN_UPDATE right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUser","name":"Update a user","isWebhook":false,"pointer":"/paths/~1users~1{userId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a user","badges":[{"name":"Access"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates a user. Only provided fields are modified."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_ADMIN:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:ADMIN_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Password can be changed via this endpoint. Same RGPD requirements apply."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_78","description":"Unique identifier of the user to update.","required":true,"example":582602}],"pointer":"/paths/~1users~1{userId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserRequest","exampleIds":["paths/~1users~1{userId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateUserRequest","exampleIds":["paths/~1users~1{userId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1users~1{userId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/users/{userId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":582602,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateUserRequest","exampleIds":["paths/~1users~1{userId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["204","403","404","422"],"pointer":"/users/{userId}","href":"users/updateuser","openApiOperationId":"updateUser","summary":"Update a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/UpdateUserRequest","exampleIds":["paths/~1users~1{userId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserRequest","exampleIds":["paths/~1users~1{userId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Updated successfully"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1users~1{userId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/updateuser"}],"panels":[]}]},"badges":[{"name":"Access"}],"httpPath":"/users/{userId}"},{"label":"Delete a user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/deleteuser","routeSlug":"/openapi/users/deleteuser","metadata":{"seo":{"title":"Delete a user","description":"Deletes a user. Their properties, customers, and other entities areautomatically reassigned according to the site's configuration rules.Requires SITE_ADMIN:WRITE permission and RS:ADMIN_DELETE right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUser","name":"Delete a user","isWebhook":false,"pointer":"/paths/~1users~1{userId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a user","badges":[{"name":"Access"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a user. Their properties, customers, and other entities are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically reassigned according to the site's configuration rules."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_ADMIN:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:ADMIN_DELETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warning:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation is irreversible. The user will be marked as deleted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(status 3) and removed from active listings."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_78","description":"Unique identifier of the user to delete.","required":true,"example":582602}],"pointer":"/paths/~1users~1{userId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/users/{userId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":582602,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["204","403","404"],"pointer":"/users/{userId}","href":"users/deleteuser","openApiOperationId":"deleteUser","summary":"Delete a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted successfully"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1users~1{userId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/deleteuser"}],"panels":[]}]},"badges":[{"name":"Access"}],"httpPath":"/users/{userId}"},{"label":"List user groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/listusergroups","routeSlug":"/openapi/users/listusergroups","metadata":{"seo":{"title":"List user groups","description":"Returns all available user groups (permission levels) for the site.Requires SITE_CONFIG permission and RS:ADMIN_GROUP_LIST right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserGroups","name":"List user groups","isWebhook":false,"pointer":"/paths/~1users~1groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user groups","badges":[{"name":"Access"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all available user groups (permission levels) for the site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CONFIG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:ADMIN_GROUP_LIST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Groups determine the access level and permissions of a user within the agency"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. \"Administrateur\", \"Négociateur\", \"Assistante\")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use group IDs when creating or updating users."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/groups","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/users/groups","href":"users/listusergroups","openApiOperationId":"listUserGroups","summary":"List user groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of groups","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111","exampleIds":["paths/~1users~1groups/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_111","exampleIds":["paths/~1users~1groups/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1users~1groups/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_111","exampleIds":["paths/~1users~1groups/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_111","exampleIds":["paths/~1users~1groups/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/listusergroups"}],"panels":[]}]},"badges":[{"name":"Access"}],"httpPath":"/users/groups"},{"label":"List user types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/listusertypes","routeSlug":"/openapi/users/listusertypes","metadata":{"seo":{"title":"List user types","description":"Returns all available user types (professional roles) for the site.Requires SITE_CONFIG permission and RS:ADMIN_TYPE_LIST right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserTypes","name":"List user types","isWebhook":false,"pointer":"/paths/~1users~1types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user types","badges":[{"name":"Access"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all available user types (professional roles) for the site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CONFIG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:ADMIN_TYPE_LIST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User types categorize the professional role (e.g. \"Négociateur\", \"Gestionnaire\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Directeur\"). A user can have multiple types."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use type IDs when creating or updating users."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/types","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/users/types","href":"users/listusertypes","openApiOperationId":"listUserTypes","summary":"List user types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of types","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_112","exampleIds":["paths/~1users~1types/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_112","exampleIds":["paths/~1users~1types/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1users~1types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_112","exampleIds":["paths/~1users~1types/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_112","exampleIds":["paths/~1users~1types/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/listusertypes"}],"panels":[]}]},"badges":[{"name":"Access"}],"httpPath":"/users/types"},{"label":"List genders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/listgenders","routeSlug":"/openapi/users/listgenders","metadata":{"seo":{"title":"List genders","description":"Returns all available gender options.Requires SITE_CONFIG permission and RS:ADMIN_GENDERS right."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGenders","name":"List genders","isWebhook":false,"pointer":"/paths/~1users~1genders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List genders","badges":[{"name":"Access"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all available gender options."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CONFIG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RS:ADMIN_GENDERS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" right."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender codes are used when creating users or customers (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"m\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"f\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some genders represent legal entities (companies) — check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/genders","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/users/genders","href":"users/listgenders","openApiOperationId":"listGenders","summary":"List genders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of genders","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113","exampleIds":["paths/~1users~1genders/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_113","exampleIds":["paths/~1users~1genders/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1users~1genders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_113","exampleIds":["paths/~1users~1genders/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_113","exampleIds":["paths/~1users~1genders/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/listgenders"}],"panels":[]}]},"badges":[{"name":"Access"}],"httpPath":"/users/genders"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"Agent and collaborator management (users, groups, types, genders)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users","summary":"List users","prefix":{"name":"get","color":"get"},"badges":[{"name":"Websites","color":"blueberry"}],"link":"/users/listusers","deprecated":false},{"title":"/users","summary":"Create a user","prefix":{"name":"post","color":"post"},"badges":[{"name":"Access"}],"link":"/users/createuser","deprecated":false},{"title":"/users/{userId}","summary":"Get a user","prefix":{"name":"get","color":"get"},"badges":[{"name":"Properties","color":"green"},{"name":"Customers","color":"purple"},{"name":"Websites","color":"blueberry"}],"link":"/users/getuser","deprecated":false},{"title":"/users/{userId}","summary":"Update a user","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Access"}],"link":"/users/updateuser","deprecated":false},{"title":"/users/{userId}","summary":"Delete a user","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Access"}],"link":"/users/deleteuser","deprecated":false},{"title":"/users/groups","summary":"List user groups","prefix":{"name":"get","color":"get"},"badges":[{"name":"Access"}],"link":"/users/listusergroups","deprecated":false},{"title":"/users/types","summary":"List user types","prefix":{"name":"get","color":"get"},"badges":[{"name":"Access"}],"link":"/users/listusertypes","deprecated":false},{"title":"/users/genders","summary":"List genders","prefix":{"name":"get","color":"get"},"badges":[{"name":"Access"}],"link":"/users/listgenders","deprecated":false}]}]}]}]}},{"type":"group","label":"Agencies","link":"/openapi/agencies","routeSlug":"/openapi/agencies","items":[{"label":"List agencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agencies/listagencies","routeSlug":"/openapi/agencies/listagencies","metadata":{"seo":{"title":"List agencies","description":"Returns all agencies accessible by the authenticated token with cursor-based pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAgencies","name":"List agencies","isWebhook":false,"pointer":"/paths/~1agencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List agencies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all agencies accessible by the authenticated token with cursor-based pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"per_page","in":"query","schemaId":"schema_107"}],"pointer":"/paths/~1agencies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/agencies","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[{"name":"per_page","in":"query","schemaId":"schema_107"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/agencies","href":"agencies/listagencies","openApiOperationId":"listAgencies","summary":"List agencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of agencies","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_114"}},"schemaId":"schema_114"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1agencies/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_114","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_114"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agencies/listagencies"}],"panels":[]}]},"httpPath":"/agencies"},{"label":"Get agency details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agencies/getagency","routeSlug":"/openapi/agencies/getagency","metadata":{"seo":{"title":"Get agency details","description":"Returns detailed information about a specific agency, including its users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAgency","name":"Get agency details","isWebhook":false,"pointer":"/paths/~1agencies~1{agencyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get agency details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns detailed information about a specific agency, including its users."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agencyId","in":"path","schemaId":"schema_78","required":true}],"pointer":"/paths/~1agencies~1{agencyId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"format","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response format. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tag_document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a simplified format used in document generation."},"children":[]}]}]}]}],"pointer":"/paths/~1agencies~1{agencyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/agencies/{agencyId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"agencyId","in":"path","required":true,"schemaId":"schema_78"}],"query":[{"name":"format","in":"query","schemaId":"schema_115"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/agencies/{agencyId}","href":"agencies/getagency","openApiOperationId":"getAgency","summary":"Get agency details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Agency details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}},"schemaId":"schema_116"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1agencies~1{agencyId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_116","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_116"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agencies/getagency"}],"panels":[]}]},"httpPath":"/agencies/{agencyId}"}],"content":{"contentType":"group","meta":{"name":"Agencies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Agencies","showPageActions":true},{"nodeType":"markdoc","content":"Agency information for the authenticated site."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/agencies","summary":"List agencies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agencies/listagencies","deprecated":false},{"title":"/agencies/{agencyId}","summary":"Get agency details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agencies/getagency","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/openapi/webhooks","routeSlug":"/openapi/webhooks","items":[{"label":"List webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/listwebhooks","routeSlug":"/openapi/webhooks/listwebhooks","metadata":{"seo":{"title":"List webhooks","description":"Returns all webhooks registered by the authenticated client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebhooks","name":"List webhooks","isWebhook":false,"pointer":"/paths/~1hooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all webhooks registered by the authenticated client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each webhook has a list of subscribed event types ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"origines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and a target URL."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hooks","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/hooks","href":"webhooks/listwebhooks","openApiOperationId":"listWebhooks","summary":"List webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of webhooks","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_117","exampleIds":["paths/~1hooks/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_117","exampleIds":["paths/~1hooks/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_117","exampleIds":["paths/~1hooks/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_117","exampleIds":["paths/~1hooks/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/listwebhooks"}],"panels":[]}]},"httpPath":"/hooks"},{"label":"Create a webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/createwebhook","routeSlug":"/openapi/webhooks/createwebhook","metadata":{"seo":{"title":"Create a webhook","description":"Registers a new webhook subscription for specific events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhook","name":"Create a webhook","isWebhook":false,"pointer":"/paths/~1hooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registers a new webhook subscription for specific events."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhooks/createwebhook/request/how-webhooks-work","deepLinkHash":"/webhooks/createwebhook#webhooks/createwebhook/request/how-webhooks-work"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How webhooks work"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks allow your application to receive real-time notifications when events"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"occur in Immofacile (e.g. a customer is created, a product is updated)."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks/createwebhook/request/subscription","deepLinkHash":"/webhooks/createwebhook#webhooks/createwebhook/request/subscription"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register a webhook by providing a target URL and the event types you want to subscribe to."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a subscribed event occurs, Immofacile sends an HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to your URL"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the event payload."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks/createwebhook/request/payload-format","deepLinkHash":"/webhooks/createwebhook#webhooks/createwebhook/request/payload-format"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload format"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each webhook payload contains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the event that triggered the notification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the ID of the affected resource"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — when the event occurred"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks/createwebhook/request/error-handling-and-retries","deepLinkHash":"/webhooks/createwebhook#webhooks/createwebhook/request/error-handling-and-retries"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error handling and retries"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your endpoint returns a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the resource is marked as errored with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reason from your response body (useful for rejecting invalid data)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your endpoint returns any other error (4xx/5xx or timeout), Immofacile retries"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"up to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 times"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with exponentially increasing delay."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After 3 failed retries, the webhook is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"suspended"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an internal log is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A suspended webhook stops receiving events until it is manually reactivated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /hooks/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks/createwebhook/request/best-practices","deepLinkHash":"/webhooks/createwebhook#webhooks/createwebhook/request/best-practices"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best practices"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Respond with HTTP 200 within "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 seconds"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to acknowledge receipt."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process the payload asynchronously on your side if business logic is heavy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return 422 with a descriptive body only when the data is intentionally rejected"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. duplicate detection, invalid state for your system)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"headers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to include an API key for authenticating incoming requests"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on your server."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhooks/createwebhook/request/available-event-types","deepLinkHash":"/webhooks/createwebhook#webhooks/createwebhook/request/available-event-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available event types"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event types follow the pattern "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE_ACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Common examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMER_CREATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — New customer created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMER_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Customer modified"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCT_CREATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — New product created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCT_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Product modified"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCT_DELETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Product deleted"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full list of available events is validated server-side. Invalid event types"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be rejected with a 422."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1hooks/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1hooks/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1hooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hooks","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1hooks/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","403","422"],"pointer":"/hooks","href":"webhooks/createwebhook","openApiOperationId":"createWebhook","summary":"Create a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1hooks/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest","exampleIds":["paths/~1hooks/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Webhook created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118","exampleIds":["paths/~1hooks/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_118","exampleIds":["paths/~1hooks/post/responses/201/content/application~1json/example"]},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1hooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_118","exampleIds":["paths/~1hooks/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_118","exampleIds":["paths/~1hooks/post/responses/201/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/createwebhook"}],"panels":[]}]},"httpPath":"/hooks"},{"label":"Update a webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/updatewebhook","routeSlug":"/openapi/webhooks/updatewebhook","metadata":{"seo":{"title":"Update a webhook","description":"Updates an existing webhook (URL, events, headers, auth)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebhook","name":"Update a webhook","isWebhook":false,"pointer":"/paths/~1hooks~1{hookId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing webhook (URL, events, headers, auth)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change the target URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add/remove subscribed event types"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update authentication headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reactivate a suspended webhook (update it with the corrected URL)"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"hookId","in":"path","schemaId":"schema_78","description":"ID of the webhook to update.","required":true,"example":42}],"pointer":"/paths/~1hooks~1{hookId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateWebhookRequest","exampleIds":["paths/~1hooks~1{hookId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateWebhookRequest","exampleIds":["paths/~1hooks~1{hookId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1hooks~1{hookId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hooks/{hookId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"hookId","in":"path","required":true,"example":42,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateWebhookRequest","exampleIds":["paths/~1hooks~1{hookId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","403","404","422"],"pointer":"/hooks/{hookId}","href":"webhooks/updatewebhook","openApiOperationId":"updateWebhook","summary":"Update a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/UpdateWebhookRequest","exampleIds":["paths/~1hooks~1{hookId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateWebhookRequest","exampleIds":["paths/~1hooks~1{hookId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_119"}},"schemaId":"schema_119"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1hooks~1{hookId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_119","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_119"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/updatewebhook"}],"panels":[]}]},"httpPath":"/hooks/{hookId}"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/deletewebhook","routeSlug":"/openapi/webhooks/deletewebhook","metadata":{"seo":{"title":"Delete a webhook","description":"Removes a webhook subscription. Events will no longer be delivered to this URL.This action is irreversible — to temporarily stop deliveries without losingthe configuration, consider updating the URL to a placeholder instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhook","name":"Delete a webhook","isWebhook":false,"pointer":"/paths/~1hooks~1{hookId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes a webhook subscription. Events will no longer be delivered to this URL."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This action is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"irreversible"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — to temporarily stop deliveries without losing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the configuration, consider updating the URL to a placeholder instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"hookId","in":"path","schemaId":"schema_78","description":"ID of the webhook to delete.","required":true,"example":42}],"pointer":"/paths/~1hooks~1{hookId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hooks/{hookId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"hookId","in":"path","required":true,"example":42,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["204","403","404"],"pointer":"/hooks/{hookId}","href":"webhooks/deletewebhook","openApiOperationId":"deleteWebhook","summary":"Delete a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted successfully"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hooks~1{hookId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/deletewebhook"}],"panels":[]}]},"httpPath":"/hooks/{hookId}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Customer event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhooks/oncustomerevent","routeSlug":"/openapi/webhooks/oncustomerevent","metadata":{"seo":{"title":"Customer event","description":"Sent to your registered URL when a subscribed customer event occurs(CUSTOMER_CREATE, CUSTOMER_UPDATE)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"onCustomerEvent","name":"Customer event","isWebhook":true,"pointer":"/paths/customerEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customer event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent to your registered URL when a subscribed "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event occurs"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMER_CREATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOMER_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Respond with HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within 10 seconds to acknowledge receipt."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to intentionally reject the resource; any other error"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"triggers up to 3 retries before the webhook is suspended."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookEventPayload","exampleIds":["paths/customerEvent/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/WebhookEventPayload","exampleIds":["paths/customerEvent/post/requestBody/content/application~1json/example"],"pointer":"/paths/customerEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"customerEvent","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookEventPayload","exampleIds":["paths/customerEvent/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"customerEvent","href":"webhooks/oncustomerevent","openApiOperationId":"onCustomerEvent","summary":"Customer event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/WebhookEventPayload","exampleIds":["paths/customerEvent/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookEventPayload","exampleIds":["paths/customerEvent/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Event acknowledged."},{"code":"422","description":"Resource intentionally rejected by the receiver."}],"pointer":"/paths/customerEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/oncustomerevent"}],"panels":[]}]},"httpPath":"customerEvent"},{"label":"Product event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhooks/onproductevent","routeSlug":"/openapi/webhooks/onproductevent","metadata":{"seo":{"title":"Product event","description":"Sent to your registered URL when a subscribed product event occurs(PRODUCT_CREATE, PRODUCT_UPDATE, PRODUCT_DELETE)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"onProductEvent","name":"Product event","isWebhook":true,"pointer":"/paths/productEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent to your registered URL when a subscribed "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" event occurs"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCT_CREATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCT_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCT_DELETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Respond with HTTP "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within 10 seconds to acknowledge receipt."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookEventPayload","exampleIds":["paths/productEvent/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/WebhookEventPayload","exampleIds":["paths/productEvent/post/requestBody/content/application~1json/example"],"pointer":"/paths/productEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"productEvent","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookEventPayload","exampleIds":["paths/productEvent/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"productEvent","href":"webhooks/onproductevent","openApiOperationId":"onProductEvent","summary":"Product event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/WebhookEventPayload","exampleIds":["paths/productEvent/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookEventPayload","exampleIds":["paths/productEvent/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Event acknowledged."},{"code":"422","description":"Resource intentionally rejected by the receiver."}],"pointer":"/paths/productEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/onproductevent"}],"panels":[]}]},"httpPath":"productEvent"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":"Event subscriptions for real-time synchronization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hooks","summary":"List webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listwebhooks","deprecated":false},{"title":"/hooks","summary":"Create a webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createwebhook","deprecated":false},{"title":"/hooks/{hookId}","summary":"Update a webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/webhooks/updatewebhook","deprecated":false},{"title":"/hooks/{hookId}","summary":"Delete a webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletewebhook","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"customerEvent","summary":"Customer event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/oncustomerevent","deprecated":false},{"title":"productEvent","summary":"Product event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/onproductevent","deprecated":false}]}]}]}]}},{"type":"group","label":"Configs","link":"/openapi/configs","routeSlug":"/openapi/configs","items":[{"label":"Get list values","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configs/getlistvalues","routeSlug":"/openapi/configs/getlistvalues","metadata":{"seo":{"title":"Get list values","description":"Returns all values for a given referential list (liste_id).Lists contain predefined values used in forms and validated fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListValues","name":"Get list values","isWebhook":false,"pointer":"/paths/~1configs~1listes~1{listeId}~1values/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list values","badges":[{"name":"Properties","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all values for a given referential list (liste_id)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists contain predefined values used in forms and validated fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common list IDs:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Room types (Chambre, Cuisine, Salon...) — used in product rooms "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expositions (Nord, Sud, Est, Ouest...) — used in rooms "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exposition"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Views (Jardin, Mer, Rue...) — used in rooms "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vue"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Floor types (Parquet, Carrelage...) — used in rooms "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sol"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer types"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compromis statuses"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forme juridique (legal form)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Situation maritale (marital status)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type de contrat (contract type)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Motifs d'annulation (cancellation reasons)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"35"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Motif d'achat (purchase motivation)"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to discover valid values before sending data that references"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"these lists (e.g. room types, customer legal form, etc.)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"listeId","in":"path","schemaId":"schema_79","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list identifier. Can be a single ID (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"1\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or comma-separated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDs to fetch multiple lists in one call (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"1,2,3\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"required":true,"example":"1"}],"pointer":"/paths/~1configs~1listes~1{listeId}~1values/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/configs/listes/{listeId}/values","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"listeId","in":"path","required":true,"example":"1","schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/configs/listes/{listeId}/values","href":"configs/getlistvalues","openApiOperationId":"getListValues","summary":"Get list values"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_120","exampleIds":["paths/~1configs~1listes~1{listeId}~1values/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_120","exampleIds":["paths/~1configs~1listes~1{listeId}~1values/get/responses/200/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — missing required pack or right"},"children":[]}]}]}]}],"pointer":"/paths/~1configs~1listes~1{listeId}~1values/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_120","exampleIds":["paths/~1configs~1listes~1{listeId}~1values/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_120","exampleIds":["paths/~1configs~1listes~1{listeId}~1values/get/responses/200/content/application~1json/example"]}}},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/configs/getlistvalues"}],"panels":[]}]},"badges":[{"name":"Properties","color":"green"}],"httpPath":"/configs/listes/{listeId}/values"}],"content":{"contentType":"group","meta":{"name":"Configs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configs","showPageActions":true},{"nodeType":"markdoc","content":"Configuration referentials such as list values."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/configs/listes/{listeId}/values","summary":"Get list values","prefix":{"name":"get","color":"get"},"badges":[{"name":"Properties","color":"green"}],"link":"/configs/getlistvalues","deprecated":false}]}]}]}]}},{"type":"group","label":"Agenda","link":"/openapi/agenda","routeSlug":"/openapi/agenda","items":[{"label":"List event types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agenda/listeventtypes","routeSlug":"/openapi/agenda/listeventtypes","metadata":{"seo":{"title":"List event types","description":"Returns the agency configured event types with their display form(visible and collapsed fields). Cursor-based pagination.Requires the MODULE_IMMO_AGENDA module and SITE_CALENDAR:READ permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEventTypes","name":"List event types","isWebhook":false,"pointer":"/paths/~1calendar~1events~1types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List event types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the agency configured event types with their display form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(visible and collapsed fields). Cursor-based pagination."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MODULE_IMMO_AGENDA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CALENDAR:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"perPage","in":"query","schemaId":"schema_121","description":"Maximum number of event types to return per page.\nValues above 50 are capped to 50.\n"},{"name":"cursor","in":"query","schemaId":"schema_79","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque pagination cursor. Pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value returned"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by the previous response to fetch the next page. Omit for the first page."},"children":[]}]}]}]}],"pointer":"/paths/~1calendar~1events~1types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calendar/events/types","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[{"name":"perPage","in":"query","schemaId":"schema_121"},{"name":"cursor","in":"query","schemaId":"schema_79"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/calendar/events/types","href":"agenda/listeventtypes","openApiOperationId":"listEventTypes","summary":"List event types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of event types","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_122"}},"schemaId":"schema_122"},{"code":"401","description":"Authentication required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1calendar~1events~1types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_122","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_122"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agenda/listeventtypes"}],"panels":[]}]},"httpPath":"/calendar/events/types"},{"label":"Get permanence timeframe","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agenda/getpermanencetimeframe","routeSlug":"/openapi/agenda/getpermanencetimeframe","metadata":{"seo":{"title":"Get permanence timeframe","description":"Returns the client reception (permanence) slots configured for an agency,grouped by day of week.Requires SITE_CALENDAR:READ."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPermanenceTimeframe","name":"Get permanence timeframe","isWebhook":false,"pointer":"/paths/~1calendar~1permanences~1timeframe/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get permanence timeframe","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the client reception (permanence) slots configured for an agency,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"grouped by day of week."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CALENDAR:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"agency_id","in":"query","schemaId":"schema_78","description":"Target agency ID whose permanence configuration is requested.\nMust belong to the agencies the authenticated client can read,\notherwise a 403 is returned.\n","required":true}],"pointer":"/paths/~1calendar~1permanences~1timeframe/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calendar/permanences/timeframe","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[{"name":"agency_id","in":"query","required":true,"schemaId":"schema_78"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","401","403","422"],"pointer":"/calendar/permanences/timeframe","href":"agenda/getpermanencetimeframe","openApiOperationId":"getPermanenceTimeframe","summary":"Get permanence timeframe"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Permanence timeframe grouped by day","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}},"schemaId":"schema_123"},{"code":"401","description":"Authentication required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1calendar~1permanences~1timeframe/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_123","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_123"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agenda/getpermanencetimeframe"}],"panels":[]}]},"httpPath":"/calendar/permanences/timeframe"},{"label":"List permanence users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agenda/listpermanenceusers","routeSlug":"/openapi/agenda/listpermanenceusers","metadata":{"seo":{"title":"List permanence users","description":"Returns the users assigned to permanence slots over a period for an agency.Defaults to the current week when from/to are omitted.Requires SITE_CALENDAR:READ."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPermanenceUsers","name":"List permanence users","isWebhook":false,"pointer":"/paths/~1calendar~1permanences~1timeframe~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List permanence users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the users assigned to permanence slots over a period for an agency."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to the current week when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CALENDAR:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"agency_id","in":"query","schemaId":"schema_78","description":"Target agency ID. Must be among the agencies the authenticated client can read,\notherwise a 403 is returned.\n","required":true},{"name":"tz","in":"query","schemaId":"schema_124","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IANA timezone used to format the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" datetimes in the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to UTC when omitted."},"children":[]}]}]}]},{"name":"from","in":"query","schemaId":"schema_125","description":"Start of the period (local datetime, no timezone suffix, format YYYY-MM-DDTHH:MM:SS).\nDefaults to the start of the current week (Monday 00:00 UTC) when omitted.\n"},{"name":"to","in":"query","schemaId":"schema_126","description":"End of the period (local datetime, no timezone suffix, format YYYY-MM-DDTHH:MM:SS).\nDefaults to the end of the current week (Sunday 23:59 UTC) when omitted.\n"}],"pointer":"/paths/~1calendar~1permanences~1timeframe~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calendar/permanences/timeframe/users","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[{"name":"agency_id","in":"query","required":true,"schemaId":"schema_78"},{"name":"tz","in":"query","example":"Europe/Paris","schemaId":"schema_124"},{"name":"from","in":"query","example":"2026-01-01T00:00:00","schemaId":"schema_125"},{"name":"to","in":"query","example":"2026-01-07T23:59:59","schemaId":"schema_126"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","401","403","422"],"pointer":"/calendar/permanences/timeframe/users","href":"agenda/listpermanenceusers","openApiOperationId":"listPermanenceUsers","summary":"List permanence users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of permanence users","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}},"schemaId":"schema_127"},{"code":"401","description":"Authentication required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1calendar~1permanences~1timeframe~1users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_127","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agenda/listpermanenceusers"}],"panels":[]}]},"httpPath":"/calendar/permanences/timeframe/users"},{"label":"Get user working time","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agenda/getuserworkingtime","routeSlug":"/openapi/agenda/getuserworkingtime","metadata":{"seo":{"title":"Get user working time","description":"Returns the working time slots of a user for the current week, grouped by day.Requires SITE_CALENDAR:READ."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserWorkingTime","name":"Get user working time","isWebhook":false,"pointer":"/paths/~1calendar~1users~1{userId}~1working-time/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user working time","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the working time slots of a user for the current week, grouped by day."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CALENDAR:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_78","description":"ID of the user (agent/collaborator) whose working time is requested.","required":true}],"pointer":"/paths/~1calendar~1users~1{userId}~1working-time/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tz","in":"query","schemaId":"schema_124","description":"IANA timezone used to express the slot hours/minutes.\nDefaults to UTC when omitted.\n"}],"pointer":"/paths/~1calendar~1users~1{userId}~1working-time/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calendar/users/{userId}/working-time","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_78"}],"query":[{"name":"tz","in":"query","example":"Europe/Paris","schemaId":"schema_124"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","401","403","422"],"pointer":"/calendar/users/{userId}/working-time","href":"agenda/getuserworkingtime","openApiOperationId":"getUserWorkingTime","summary":"Get user working time"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Working time grouped by day","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}},"schemaId":"schema_128"},{"code":"401","description":"Authentication required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1calendar~1users~1{userId}~1working-time/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_128","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agenda/getuserworkingtime"}],"panels":[]}]},"httpPath":"/calendar/users/{userId}/working-time"},{"label":"Get user availability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agenda/getuseravailability","routeSlug":"/openapi/agenda/getuseravailability","metadata":{"seo":{"title":"Get user availability","description":"Returns the available slots of a user over a period, computed from theirworking time and existing events. Defaults to the current week whenfrom/to are omitted.Requires SITE_CALENDAR:READ."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserAvailability","name":"Get user availability","isWebhook":false,"pointer":"/paths/~1calendar~1users~1{userId}~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the available slots of a user over a period, computed from their"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"working time and existing events. Defaults to the current week when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CALENDAR:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_78","description":"ID of the user (agent/collaborator) whose availability is computed.","required":true}],"pointer":"/paths/~1calendar~1users~1{userId}~1availability/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"tz","in":"query","schemaId":"schema_124","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IANA timezone used to format the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" datetimes of the returned slots."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to UTC when omitted."},"children":[]}]}]}]},{"name":"from","in":"query","schemaId":"schema_125","description":"Start of the period (local datetime, format YYYY-MM-DDTHH:MM:SS).\nDefaults to the start of the current week (Monday 00:00 UTC) when omitted.\n"},{"name":"to","in":"query","schemaId":"schema_126","description":"End of the period (local datetime, format YYYY-MM-DDTHH:MM:SS).\nDefaults to the end of the current week (Sunday 23:59 UTC) when omitted.\n"},{"name":"slot_duration","in":"query","schemaId":"schema_129","description":"Desired duration of each returned availability slot, in minutes.\nWhen omitted, a default slot granularity is used.\n"},{"name":"exclude_types","in":"query","schemaId":"schema_130","description":"Event type keys to ignore when computing availability. Events of these\ntypes do not make the corresponding slots unavailable.\n"}],"pointer":"/paths/~1calendar~1users~1{userId}~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calendar/users/{userId}/availability","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_78"}],"query":[{"name":"tz","in":"query","example":"Europe/Paris","schemaId":"schema_124"},{"name":"from","in":"query","example":"2026-01-01T00:00:00","schemaId":"schema_125"},{"name":"to","in":"query","example":"2026-01-07T23:59:59","schemaId":"schema_126"},{"name":"slot_duration","in":"query","example":30,"schemaId":"schema_129"},{"name":"exclude_types","in":"query","example":["FREE"],"schemaId":"schema_130"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","401","403","422"],"pointer":"/calendar/users/{userId}/availability","href":"agenda/getuseravailability","openApiOperationId":"getUserAvailability","summary":"Get user availability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of available slots","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_131"}},"schemaId":"schema_131"},{"code":"401","description":"Authentication required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1calendar~1users~1{userId}~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_131","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_131"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agenda/getuseravailability"}],"panels":[]}]},"httpPath":"/calendar/users/{userId}/availability"},{"label":"List shared agendas","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agenda/listsharedagendas","routeSlug":"/openapi/agenda/listsharedagendas","metadata":{"seo":{"title":"List shared agendas","description":"Returns the agendas accessible by the given user (users whose calendar is shared with them).Requires SITE_CALENDAR:READ."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSharedAgendas","name":"List shared agendas","isWebhook":false,"pointer":"/paths/~1calendar~1users~1{userId}~1shared-agenda/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List shared agendas","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the agendas accessible by the given user (users whose calendar is shared with them)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CALENDAR:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_78","description":"ID of the user for whom accessible (shared) agendas are listed.\nThe response contains the users whose calendar this user is allowed to view.\n","required":true}],"pointer":"/paths/~1calendar~1users~1{userId}~1shared-agenda/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calendar/users/{userId}/shared-agenda","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/calendar/users/{userId}/shared-agenda","href":"agenda/listsharedagendas","openApiOperationId":"listSharedAgendas","summary":"List shared agendas"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of accessible agendas","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}},"schemaId":"schema_132"},{"code":"401","description":"Authentication required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1calendar~1users~1{userId}~1shared-agenda/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_132","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agenda/listsharedagendas"}],"panels":[]}]},"httpPath":"/calendar/users/{userId}/shared-agenda"},{"label":"Search events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agenda/searchevents","routeSlug":"/openapi/agenda/searchevents","metadata":{"seo":{"title":"Search events","description":"Searches events over a period with optional filters. Defaults to the currentday when from/to are omitted. Recurring events are expanded by default.Requires SITE_CALENDAR:READ."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchEvents","name":"Search events","isWebhook":false,"pointer":"/paths/~1calendar~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches events over a period with optional filters. Defaults to the current"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"day when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted. Recurring events are expanded by default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CALENDAR:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"user_id","in":"query","schemaId":"schema_78","description":"Restricts event visibility to this user's perspective. Affects which\nconfidential/private events are returned.\n"},{"name":"user_ids","in":"query","schemaId":"schema_106","description":"Restricts the result to events involving these user (agent) IDs as participants.\n"},{"name":"agency_ids","in":"query","schemaId":"schema_106","description":"Restricts the result to events belonging to these agency IDs.\nEach ID must be among the agencies the authenticated client can read,\notherwise a 403 is returned.\n"},{"name":"tz","in":"query","schemaId":"schema_124","description":"IANA timezone applied to the returned event datetimes.\nDefaults to UTC when omitted.\n"},{"name":"from","in":"query","schemaId":"schema_125","description":"Start of the search window (local datetime, format YYYY-MM-DDTHH:MM:SS).\nDefaults to the start of the current day (00:00 UTC) when omitted.\n"},{"name":"to","in":"query","schemaId":"schema_133","description":"End of the search window (local datetime, format YYYY-MM-DDTHH:MM:SS).\nDefaults to the end of the current day (23:59 UTC) when omitted.\n"},{"name":"perPage","in":"query","schemaId":"schema_121","description":"Maximum number of events to return. Values above 50 are capped to 50.\n"},{"name":"offset","in":"query","schemaId":"schema_97","description":"Number of events to skip from the start of the result set (offset pagination)."},{"name":"excluded_types","in":"query","schemaId":"schema_134","description":"Event type ids to exclude from the result (e.g. to hide working-time or\nfree slots from a calendar view).\n"},{"name":"recurring","in":"query","schemaId":"schema_135","description":"When true (default), recurring events are expanded into their individual\noccurrences within the search window. When false, only the master event is returned.\n"},{"name":"archived","in":"query","schemaId":"schema_136","description":"When false (default), archived events are excluded. Set to true to include\narchived events in the result.\n"}],"pointer":"/paths/~1calendar~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calendar/events","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[{"name":"user_id","in":"query","schemaId":"schema_78"},{"name":"user_ids","in":"query","schemaId":"schema_106"},{"name":"agency_ids","in":"query","schemaId":"schema_106"},{"name":"tz","in":"query","example":"Europe/Paris","schemaId":"schema_124"},{"name":"from","in":"query","example":"2026-01-01T00:00:00","schemaId":"schema_125"},{"name":"to","in":"query","example":"2026-01-31T23:59:59","schemaId":"schema_133"},{"name":"perPage","in":"query","schemaId":"schema_121"},{"name":"offset","in":"query","schemaId":"schema_97"},{"name":"excluded_types","in":"query","example":["1","2"],"schemaId":"schema_134"},{"name":"recurring","in":"query","schemaId":"schema_135"},{"name":"archived","in":"query","schemaId":"schema_136"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","401","403","422"],"pointer":"/calendar/events","href":"agenda/searchevents","openApiOperationId":"searchEvents","summary":"Search events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of events","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_137"}},"schemaId":"schema_137"},{"code":"401","description":"Authentication required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1calendar~1events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_137","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_137"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agenda/searchevents"}],"panels":[]}]},"httpPath":"/calendar/events"},{"label":"Create an event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agenda/createevent","routeSlug":"/openapi/agenda/createevent","metadata":{"seo":{"title":"Create an event","description":"Creates a calendar event. Exactly one participant must be flagged asis_organizer and exactly one as is_creator, and each participantmust have a unique user_id.Requires SITE_CALENDAR:WRITE."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEvent","name":"Create an event","isWebhook":false,"pointer":"/paths/~1calendar~1events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a calendar event. Exactly one participant must be flagged as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_organizer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and exactly one as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_creator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and each participant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must have a unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CALENDAR:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEventRequest"}},"schemaId":"components/schemas/CreateEventRequest","pointer":"/paths/~1calendar~1events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/calendar/events","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEventRequest"}},"responseCodes":["200","401","403","422"],"pointer":"/calendar/events","href":"agenda/createevent","openApiOperationId":"createEvent","summary":"Create an event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/CreateEventRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEventRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Event created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}},"schemaId":"schema_138"},{"code":"401","description":"Authentication required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1calendar~1events/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_138","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agenda/createevent"}],"panels":[]}]},"httpPath":"/calendar/events"},{"label":"Get an event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agenda/getevent","routeSlug":"/openapi/agenda/getevent","metadata":{"seo":{"title":"Get an event","description":"Returns a single event by ID.Requires SITE_CALENDAR:READ."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEvent","name":"Get an event","isWebhook":false,"pointer":"/paths/~1calendar~1events~1{eventId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a single event by ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CALENDAR:READ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"eventId","in":"path","schemaId":"schema_78","description":"ID of the event to retrieve.","required":true}],"pointer":"/paths/~1calendar~1events~1{eventId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/calendar/events/{eventId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"eventId","in":"path","required":true,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/calendar/events/{eventId}","href":"agenda/getevent","openApiOperationId":"getEvent","summary":"Get an event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Event details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}},"schemaId":"schema_138"},{"code":"401","description":"Authentication required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1calendar~1events~1{eventId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_138","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agenda/getevent"}],"panels":[]}]},"httpPath":"/calendar/events/{eventId}"},{"label":"Update an event","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agenda/updateevent","routeSlug":"/openapi/agenda/updateevent","metadata":{"seo":{"title":"Update an event","description":"Partially updates an event. When participants are provided, exactly onemust be flagged is_organizer and exactly one is_creator, with unique user_id.Requires SITE_CALENDAR:WRITE."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEvent","name":"Update an event","isWebhook":false,"pointer":"/paths/~1calendar~1events~1{eventId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates an event. When participants are provided, exactly one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must be flagged "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_organizer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and exactly one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_creator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CALENDAR:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"eventId","in":"path","schemaId":"schema_78","description":"ID of the event to update.","required":true}],"pointer":"/paths/~1calendar~1events~1{eventId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEventRequest"}},"schemaId":"components/schemas/UpdateEventRequest","pointer":"/paths/~1calendar~1events~1{eventId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/calendar/events/{eventId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"eventId","in":"path","required":true,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEventRequest"}},"responseCodes":["200","401","403","404","422"],"pointer":"/calendar/events/{eventId}","href":"agenda/updateevent","openApiOperationId":"updateEvent","summary":"Update an event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"components/schemas/UpdateEventRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEventRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Event updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}},"schemaId":"schema_138"},{"code":"401","description":"Authentication required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1calendar~1events~1{eventId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_138","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agenda/updateevent"}],"panels":[]}]},"httpPath":"/calendar/events/{eventId}"},{"label":"Delete an event","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agenda/deleteevent","routeSlug":"/openapi/agenda/deleteevent","metadata":{"seo":{"title":"Delete an event","description":"Permanently deletes an event.Requires SITE_CALENDAR:WRITE."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEvent","name":"Delete an event","isWebhook":false,"pointer":"/paths/~1calendar~1events~1{eventId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permanently deletes an event."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CALENDAR:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"eventId","in":"path","schemaId":"schema_78","description":"ID of the event to permanently delete. This is irreversible; to keep the\nevent but hide it, use the status endpoint to archive it instead.\n","required":true}],"pointer":"/paths/~1calendar~1events~1{eventId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/calendar/events/{eventId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"eventId","in":"path","required":true,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/calendar/events/{eventId}","href":"agenda/deleteevent","openApiOperationId":"deleteEvent","summary":"Delete an event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted successfully"},{"code":"401","description":"Authentication required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1calendar~1events~1{eventId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agenda/deleteevent"}],"panels":[]}]},"httpPath":"/calendar/events/{eventId}"},{"label":"Change event status","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/agenda/changeeventstatus","routeSlug":"/openapi/agenda/changeeventstatus","metadata":{"seo":{"title":"Change event status","description":"Archives or restores an event.Requires SITE_CALENDAR:WRITE."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"changeEventStatus","name":"Change event status","isWebhook":false,"pointer":"/paths/~1calendar~1events~1{eventId}~1status/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change event status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Archives or restores an event."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SITE_CALENDAR:WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"opaque"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"eventId","in":"path","schemaId":"schema_78","description":"ID of the event to archive or restore.","required":true}],"pointer":"/paths/~1calendar~1events~1{eventId}~1status/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_139"}},"schemaId":"schema_139","pointer":"/paths/~1calendar~1events~1{eventId}~1status/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/calendar/events/{eventId}/status","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"parameters":{"path":[{"name":"eventId","in":"path","required":true,"schemaId":"schema_78"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_139"}},"responseCodes":["200","401","403","404","422"],"pointer":"/calendar/events/{eventId}/status","href":"agenda/changeeventstatus","openApiOperationId":"changeEventStatus","summary":"Change event status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com"}}}],"schemaId":"schema_139","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_139"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Event status changed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}},"schemaId":"schema_138"},{"code":"401","description":"Authentication required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}},"schemaId":"components/schemas/ValidationErrorResponse"}],"pointer":"/paths/~1calendar~1events~1{eventId}~1status/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_138","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_138"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ValidationErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agenda/changeeventstatus"}],"panels":[]}]},"httpPath":"/calendar/events/{eventId}/status"}],"content":{"contentType":"group","meta":{"name":"Agenda"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Agenda","showPageActions":true},{"nodeType":"markdoc","content":"Calendar events, availabilities, permanences, and working time."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/calendar/events/types","summary":"List event types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agenda/listeventtypes","deprecated":false},{"title":"/calendar/permanences/timeframe","summary":"Get permanence timeframe","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agenda/getpermanencetimeframe","deprecated":false},{"title":"/calendar/permanences/timeframe/users","summary":"List permanence users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agenda/listpermanenceusers","deprecated":false},{"title":"/calendar/users/{userId}/working-time","summary":"Get user working time","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agenda/getuserworkingtime","deprecated":false},{"title":"/calendar/users/{userId}/availability","summary":"Get user availability","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agenda/getuseravailability","deprecated":false},{"title":"/calendar/users/{userId}/shared-agenda","summary":"List shared agendas","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agenda/listsharedagendas","deprecated":false},{"title":"/calendar/events","summary":"Search events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agenda/searchevents","deprecated":false},{"title":"/calendar/events","summary":"Create an event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agenda/createevent","deprecated":false},{"title":"/calendar/events/{eventId}","summary":"Get an event","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agenda/getevent","deprecated":false},{"title":"/calendar/events/{eventId}","summary":"Update an event","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/agenda/updateevent","deprecated":false},{"title":"/calendar/events/{eventId}","summary":"Delete an event","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/agenda/deleteevent","deprecated":false},{"title":"/calendar/events/{eventId}/status","summary":"Change event status","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/agenda/changeeventstatus","deprecated":false}]}]}]}]}},{"type":"separator","label":"About","content":null},{"type":"group","label":"Changelog","link":"/openapi/changelog","routeSlug":"/openapi/changelog","items":[{"type":"link","label":"1.1.0 — 2026-09-16","link":"/openapi/changelog/1.1.0-2026-09-16","routeSlug":"/openapi/changelog/1.1.0-2026-09-16","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"1.1.0 — 2026-09-16"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"changelog/1.1.0-2026-09-16"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1.1.0 — 2026-09-16"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Added","link":"/openapi/changelog/added","routeSlug":"/openapi/changelog/added","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Added"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"changelog/added"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Added"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Richer customer profiles: phone numbers, mandates, client-area access,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"color, notary, and related contacts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"More detail on search requests: criteria, key points (pros/cons),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and search areas."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer addresses and phone numbers can now be written using the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"structure returned by the API."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Changed","link":"/openapi/changelog/changed","routeSlug":"/openapi/changelog/changed","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Changed"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"changelog/changed"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changed"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response and request keys now use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snake_case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" across the whole API."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Deprecated","link":"/openapi/changelog/deprecated","routeSlug":"/openapi/changelog/deprecated","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Deprecated"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"changelog/deprecated"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"camelCase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys are deprecated in favor of their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snake_case"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equivalents. They remain accepted for now (the new key takes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"precedence when both are sent) and will be removed in a future major"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"release."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"1.0.0 — 2026-06-17","link":"/openapi/changelog/1.0.0-2026-06-17","routeSlug":"/openapi/changelog/1.0.0-2026-06-17","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"1.0.0 — 2026-06-17"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"changelog/1.0.0-2026-06-17"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1.0.0 — 2026-06-17"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Added","link":"/openapi/changelog/added","routeSlug":"/openapi/changelog/added","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Added"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"changelog/added"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Added"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First public release of the V2 API (REST, OAuth 2.0 authentication)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints for Products, Customers, Leads, Transactions, Users, Agencies, Configs, and Calendar."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks system for real-time synchronization."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discovery endpoint to dynamically discover accessible resources."},"children":[]}]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"Changelog"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Changelog","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version history for the Immofacile API V2. Changes follow"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"semantic versioning and the Keep a Changelog format ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Added"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deprecated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Removed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fixed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Security"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This version number tracks the evolution of the API contract and is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"independent of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL prefix, which is a stable interface level"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and does not change with these releases."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/changelog"}],"panels":[]}]}}],"store":{"schemaStore":{"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"}}}},"components/schemas/ValidationErrorResponse":{"id":"components/schemas/ValidationErrorResponse","kind":"json-schema","title":"ValidationErrorResponse","data":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}}}}}},"components/schemas/DiscoveryAgency":{"id":"components/schemas/DiscoveryAgency","kind":"json-schema","title":"DiscoveryAgency","data":{"type":"object","description":"An agency (manufacturer) accessible by the authenticated client.","properties":{"site_id":{"type":"integer","description":"Site ID this agency belongs to.","example":100},"agency_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agency ID. Use this value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agency_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in create/update requests."},"children":[]}]}]}],"example":123},"name":{"type":"string","description":"Commercial name of the agency.","example":"Agence Centre Ville"},"legal_name":{"type":["string","null"],"description":"Legal company name.","example":"SAS Immobilier Centre"},"address":{"type":["string","null"],"description":"Street address.","example":"15 rue de la République"},"postal_code":{"type":["string","null"],"description":"Postal code.","example":"69001"},"city":{"type":["string","null"],"description":"City.","example":"Lyon"},"email":{"type":["string","null"],"description":"Agency contact email.","example":"centre@agence.fr"},"phone":{"type":["string","null"],"description":"Agency phone number.","example":"+33472123456"},"siret":{"type":["string","null"],"description":"SIRET number (French business ID, 14 digits).","example":"12345678901234"},"siren":{"type":["string","null"],"description":"SIREN number (French company ID, 9 digits).","example":"123456789"}}}},"components/schemas/AgencyResponse":{"id":"components/schemas/AgencyResponse","kind":"json-schema","title":"AgencyResponse","data":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":["string","null"]},"description":{"type":["string","null"]},"model":{"type":["string","null"]},"schedule":{"type":["string","null"]},"is_demo":{"type":"boolean"},"fee_schedule":{"type":["string","null"],"description":"Fee schedule image URL"},"site_id":{"type":["integer","null"]},"site_code":{"type":["string","null"]},"logo":{"type":["string","null"],"description":"Logo URL"},"picture":{"type":["string","null"],"description":"Agency photo URL"},"location":{"type":"object","properties":{"address":{"type":["string","null"]},"zip_code":{"type":["string","null"]},"city":{"type":["string","null"]},"coordinates":{"type":["object","null"],"properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}}}},"phones":{"type":"object","properties":{"phone":{"type":["string","null"]},"phone_location":{"type":["string","null"]}}},"emails":{"type":"object","properties":{"email":{"type":["string","null"]},"email_leasing":{"type":["string","null"]}}},"details":{"type":["object","null"],"description":"Agency detail information"}}}},"components/schemas/CursorPaginationMeta":{"id":"components/schemas/CursorPaginationMeta","kind":"json-schema","title":"CursorPaginationMeta","data":{"type":"object","properties":{"per_page":{"type":"integer","example":50},"next_cursor":{"type":["string","null"],"example":"eyJpZCI6MTIzfQ=="},"prev_cursor":{"type":["string","null"]}}}},"components/schemas/CursorPaginationLinks":{"id":"components/schemas/CursorPaginationLinks","kind":"json-schema","title":"CursorPaginationLinks","data":{"type":"object","properties":{"next":{"type":["string","null"]},"prev":{"type":["string","null"]}}}},"components/schemas/AgencyFullResponse":{"id":"components/schemas/AgencyFullResponse","kind":"json-schema","title":"AgencyFullResponse","data":{"allOf":[{"$ref":"#/components/schemas/AgencyResponse"},{"type":"object","properties":{"social_links":{"type":["object","null"],"description":"Social media links"},"users":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":"integer"},"firstname":{"type":["string","null"]},"lastname":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"mobile_phone":{"type":["string","null"]},"status":{"type":["integer","null"]},"picture":{"type":["string","null"]}}},"description":"List of users (agents) attached to the agency"}}}]}},"components/schemas/CreateProductRequest":{"id":"components/schemas/CreateProductRequest","kind":"json-schema","title":"CreateProductRequest","data":{"type":"object","required":["agency_id","criteria"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for creating a product. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agency_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are required."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other fields are optional."},"children":[]}]}]}],"properties":{"agency_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agency ID for the product. Must be within the authenticated site's scope"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(validated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manufacturer_in_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /agencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list available IDs."},"children":[]}]}]}],"example":123},"user_id":{"type":["integer","null"],"description":"Assigned user (agent) ID. The agent responsible for this property listing.\n","example":456},"model":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product reference (mandate number, agency reference, your own identifier)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-generated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if omitted — the system produces the next sequential reference"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the agency. You can use this field to store your own cross-reference ID."},"children":[]}]}]}],"example":"REF-2025-001"},"descriptions":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web descriptions for the product (multilingual). Each entry requires a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ISO 639-2, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"fr\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"items":{"type":"object","required":["language_code"],"properties":{"title":{"type":["string","null"],"description":"Short title.","example":"Bel appartement lumineux"},"description":{"type":["string","null"],"description":"Full description text.","example":"Situé au 3ème étage avec ascenseur, cet appartement..."},"language_code":{"type":"string","description":"ISO 639-2 language code.","example":"fr"}}}},"criteria":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product criteria array. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each criterion is an object with:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Either the XML key (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"TypeBien\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or numeric ID (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"27\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both are resolved by the validator."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Format depends on criteria type:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIQUE: exact "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" string from the referential (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criterias/product/{id}/values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Appartement\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", NOT the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"numeric ID like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"1\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NUMBER: numeric value as string (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"85.5\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FLAG: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEXT: free text string"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MULTIPLE: array of value code strings"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DATE: ISO 8601 datetime or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dd/MM/yyyy"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandatory criteria:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TypeBien"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ID 27) — Property type (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Appartement\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Maison\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TypeTransaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ID 28) — Transaction type (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Vente\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Location\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CPVille"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ID 65) — Or alternatively "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CodePostal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ville"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (auto-composed)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended criteria:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Statut"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Product status. Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"EnCours\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the product to be active"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and visible. If omitted, the site's default applies (which may create an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inactive product)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DPE auto-calculation:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If you provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conso_energ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (numeric) without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ConsoEner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (letter), the system auto-calculates the DPE letter based on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property type and country. Same for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valeur_GES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GPS auto-geocoding:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If you provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Adresse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CodePostal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ville"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Alentour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the system geocodes the address automatically."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Alentour"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" directly (format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"lat,lng\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to bypass geocoding."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criterias/product/all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover available criteria and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criterias/product/{id}/values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for valid values."},"children":[]}]}]}],"items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","description":"Criteria identifier (XML key or numeric ID).","example":"TypeBien"},"value":{"description":"Criteria value (format depends on type).","example":"Appartement"}}},"example":[{"id":"TypeBien","value":"Appartement"},{"id":"TypeTransaction","value":"Vente"},{"id":"Statut","value":"EnCours"},{"id":"NbPieces","value":"4"},{"id":"Surface","value":"85.5"},{"id":"Prix","value":"350000"},{"id":"conso_energ","value":"125"},{"id":"Adresse","value":"12 rue de la Paix"},{"id":"CodePostal","value":"75002"},{"id":"Ville","value":"Paris"}]},"rooms":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Room list. Each room requires a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from referential list 1."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /configs/listes/1/values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover room types."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list 1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Room type (e.g. \"Chambre\", \"Cuisine\")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"niveau"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"numeric"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Floor level"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surface"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"numeric"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surface in m²"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exposition"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list 2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exposure (Nord, Sud, Est, Ouest...)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vue"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list 3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View (Jardin, Mer, Rue...)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sol"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list 4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Floor type (Parquet, Carrelage...)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"commentaire"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free comment"},"children":[]}]}]}]}]}]}],"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Room type from list 1.","example":"Chambre"},"niveau":{"type":["number","null"],"description":"Floor level."},"surface":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surface in m²."},"children":[]}]}]}],"example":14.5},"exposition":{"type":["string","null"],"description":"Exposure from list 2."},"vue":{"type":["string","null"],"description":"View from list 3."},"sol":{"type":["string","null"],"description":"Floor type from list 4."},"commentaire":{"type":["string","null"],"description":"Free comment."}}}},"customer_id":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing customer ID to link as the property owner/seller."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"example":789},"customer":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new customer and link as owner. Used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided."},"children":[]}]}]}]}}}},"components/schemas/ProductSummary":{"id":"components/schemas/ProductSummary","kind":"json-schema","title":"ProductSummary","data":{"type":"object","properties":{"id":{"type":"integer"},"status":{"type":["string","null"]},"price":{"type":["number","null"]},"agency_id":{"type":"integer"},"model":{"type":["string","null"]},"image":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"last_modified":{"type":["string","null"],"format":"date-time"}}}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"type":"object","properties":{"id":{"type":"integer"},"model":{"type":["string","null"],"description":"Product reference"},"status":{"type":["string","null"]},"price":{"type":["number","null"]},"userId":{"type":["integer","null"],"description":"Assigned user (agent) ID"},"customerId":{"type":["integer","null"]},"agencyId":{"type":"integer","description":"Agency ID"},"parentId":{"type":["integer","null"]},"parentId2":{"type":["integer","null"]},"statusWeb":{"type":["boolean","null"]},"statusVitrine":{"type":["boolean","null"]},"statusPrice":{"type":["string","null"]},"image":{"type":["string","null"],"description":"Main photo URL"},"feesSellerPercent":{"type":["number","null"]},"feesBuyerPercent":{"type":["number","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"dateAvailability":{"type":["string","null"],"format":"date-time"},"nextContact":{"type":["string","null"],"format":"date-time"},"gav":{"type":["boolean","null"]},"selection":{"type":["boolean","null"]},"color":{"type":["string","null"]},"intercabinet":{"type":["boolean","null"]},"sellerStatistics":{"type":["object","null"]},"descriptions":{"type":["array","null"],"items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"language_code":{"type":"string"}}}},"criteresText":{"type":["array","null"],"items":{"type":"object"}},"criteresFullText":{"type":["array","null"],"items":{"type":"object"}},"criteresNumber":{"type":["array","null"],"items":{"type":"object"}},"criteresFlag":{"type":["array","null"],"items":{"type":"object"}},"rooms":{"type":["array","null"],"items":{"type":"object"}},"photos":{"type":["array","null"],"items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":["string","null"]}}}},"customer":{"type":["object","null"]}}}},"components/schemas/UpdateProductRequest":{"id":"components/schemas/UpdateProductRequest","kind":"json-schema","title":"UpdateProductRequest","data":{"type":"object","required":["product_id"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial product update. Only provided fields are modified."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body for scope verification"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(must match the path parameter value)."},"children":[]}]}]}],"properties":{"product_id":{"type":"integer","description":"Product ID (must match path parameter). Required for scope validation.\n","example":12345},"agency_id":{"type":["integer","null"],"description":"Transfer product to another agency (must remain in scope).","example":456},"model":{"type":["string","null"],"description":"Change product reference.","example":"REF-2025-002"},"user_id":{"type":["integer","null"],"description":"Change assigned agent.","example":789},"intercabinet":{"type":["boolean","null"],"description":"Enable/disable inter-agency sharing."},"color":{"type":["integer","null"],"minimum":1,"maximum":5,"description":"Color code (1-5) for visual categorization."},"next_contact":{"type":["string","null"],"format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Next follow-up date (format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"2026-02-15"},"seller_statistics":{"type":["boolean","null"],"description":"Enable/disable seller statistics."},"web_status":{"type":["boolean","null"],"description":"Enable/disable web publication."},"rooms":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Room list update. Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update existing rooms, omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to add new ones."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In update mode, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mutually exclusive"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a given room."},"children":[]}]}]}],"items":{"type":"object","properties":{"id":{"type":["number","null"],"description":"Existing room ID (for update). Omit for new rooms."},"type":{"type":["string","null"],"description":"Room type from list 1 (nullable in update)."},"niveau":{"type":["string","null"]},"surface":{"type":["number","null"]},"exposition":{"type":["string","null"]},"vue":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View (mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in update)."},"children":[]}]}]}]},"sol":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Floor type (mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in update)."},"children":[]}]}]}]},"commentaire":{"type":["string","null"]}}}},"descriptions":{"type":["array","null"],"description":"Web descriptions (same format as create).","items":{"type":"object","properties":{"title":{"type":["string","null"]},"description":{"type":["string","null"]},"language_code":{"type":"string"}}}},"criteria":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria to update. Only provided criteria are modified — existing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"criteria not in this array are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"preserved"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not reset)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format is same as create, except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (to clear a criterion)."},"children":[]}]}]}],"items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Criteria identifier (XML key or numeric ID)."},"value":{"description":"New value (null to clear)."}}}}}}},"components/schemas/ProductListItem":{"id":"components/schemas/ProductListItem","kind":"json-schema","title":"ProductListItem","data":{"type":"object","properties":{"id":{"type":"integer"},"customers_id":{"type":["integer","null"]},"parent_id":{"type":["integer","null"]},"parent_id2":{"type":["integer","null"]},"quantity":{"type":"integer"},"model":{"type":["string","null"]},"status_web":{"type":"boolean"},"image":{"type":["string","null"]},"agency_id":{"type":"integer"},"price":{"type":["number","null"]},"fees_seller":{"type":["number","null"]},"fees_buyer":{"type":["number","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"last_modified":{"type":["string","null"],"format":"date-time"},"date_availability":{"type":["string","null"],"format":"date-time"},"next_contact":{"type":["string","null"],"format":"date-time"},"gav":{"type":"boolean"},"products_selection":{"type":"boolean"},"category":{"type":["object","null"],"properties":{"id":{"type":"integer"},"parent_id":{"type":["integer","null"]},"name":{"type":["string","null"]},"order":{"type":["integer","null"]},"matching_criteres":{"type":["string","null"]},"parent":{"type":["object","null"],"description":"Recursive parent category"}}},"themes":{"type":["array","null"],"items":{"type":"object","properties":{"id":{"type":["integer","null"]},"name":{"type":["string","null"]}}}}}}},"components/schemas/CriteriaResource":{"id":"components/schemas/CriteriaResource","kind":"json-schema","title":"CriteriaResource","data":{"type":"object","properties":{"xml":{"type":["string","null"],"description":"Criteria XML identifier"},"id":{"type":"integer","description":"Criteria ID"},"priority":{"type":["integer","null"]},"type":{"type":["string","null"],"description":"Criteria type (text, number, flag, etc.)"},"label":{"type":["string","null"],"description":"Localized label"},"personalizable":{"type":"boolean"},"is_visible":{"type":"boolean","description":"Whether the criteria is visible for the current editeur"},"is_activated":{"type":"boolean"},"is_confidential":{"type":"boolean"},"is_confidential_disabled":{"type":"boolean"},"is_activated_disabled":{"type":"boolean"},"is_fiche_co_visible":{"type":"boolean"},"is_fiche_co_visible_disabled":{"type":"boolean"},"is_activated_form_seller":{"type":"boolean"}}}},"components/schemas/CustomerPhoneBody":{"id":"components/schemas/CustomerPhoneBody","kind":"json-schema","title":"CustomerPhoneBody","data":{"type":"object","required":["slot","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A phone entry addressed by its slot. Mirrors the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array returned"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by the API (in read, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id, label}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object; in write, provide"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"slot":{"type":"integer","minimum":1,"maximum":4,"description":"Phone slot (1-4).","example":1},"number":{"type":["string","null"],"example":"+33201010101"},"type_id":{"type":["integer","null"],"description":"Phone type ID."},"stop_sms":{"type":["boolean","null"],"description":"SMS opt-out flag for this number.","example":false}}}},"components/schemas/CustomerAddressBody":{"id":"components/schemas/CustomerAddressBody","kind":"json-schema","title":"CustomerAddressBody","data":{"type":"object","description":"Customer address block.\n","properties":{"street":{"type":["string","null"],"example":"105 Rue Charles Nungesser"},"complement":{"type":["string","null"]},"postcode":{"type":["string","null"],"example":"29490"},"city":{"type":["string","null"],"example":"Guipavas"},"country":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country name or ISO 3166-1 alpha-2 code (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"FR"},"residence":{"type":["string","null"]},"latitude":{"type":["string","null"],"example":"48.44145"},"longitude":{"type":["string","null"],"example":"-4.415114"}}}},"components/schemas/CustomerSubscriptionsField":{"id":"components/schemas/CustomerSubscriptionsField","kind":"json-schema","title":"CustomerSubscriptionsField","data":{"type":["array","null"],"description":"Customer alert subscriptions. Each item controls a specific subscription channel.\n","items":{"type":"object","required":["id","active"],"properties":{"id":{"type":"string","enum":["proposition_bien","abonne_newsletter","customers_partenaires"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available subscriptions: * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"proposition_bien"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Accepts property proposals * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"abonne_newsletter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Accepts newsletters * "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customers_partenaires"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Accepts partner emails"},"children":[]}]}]}]},"active":{"type":"boolean","description":"Whether this subscription is active."}}},"example":[{"id":"proposition_bien","active":true},{"id":"abonne_newsletter","active":false}]}},"components/schemas/CreateCustomerRequest":{"id":"components/schemas/CreateCustomerRequest","kind":"json-schema","title":"CreateCustomerRequest","data":{"type":"object","required":["email"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a customer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required and at least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided. Duplicate detection is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"performed on "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email OR phones"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"gender":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer gender code. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /users/genders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for available values."},"children":[]}]}]}],"example":"m"},"first_name":{"type":["string","null"],"example":"Jean"},"last_name":{"type":["string","null"],"example":"Dupont"},"business_name":{"type":["string","null"],"description":"Company name (for professional customers)."},"email":{"type":"string","format":"email","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer email address. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]}]}]}],"example":"jean.dupont@example.com"},"phones":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone numbers, one entry per slot (1-4). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identifies the position; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CustomerPhoneBody"}},"phone":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array (slot 1)."},"children":[]}]}]}],"example":"+33201010101"},"mobile_phone":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array (slot 3)."},"children":[]}]}]}],"example":"+33601010101"},"origin_id":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer origin ID. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /customers/origins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":12},"assigned_user_id":{"type":["integer","null"],"description":"Assigned negotiator (agent) ID.","example":123456},"agency_id":{"type":["integer","null"],"description":"Agency ID (within the authenticated site's scope).","example":123456},"next_contact_at":{"type":["string","null"],"format":"date-time"},"reference":{"type":["string","null"],"description":"Internal reference of the customer."},"comments":{"type":["string","null"],"description":"Internal notes"},"current_situation_id":{"type":["integer","null"],"description":"Current situation list value ID (liste 5)."},"group":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer group ID. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /customers/groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},"groups":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of customer group IDs. Takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2]},"address":{"$ref":"#/components/schemas/CustomerAddressBody"},"newsletter":{"type":["boolean","null"],"description":"Whether or not the customer agrees to receive communications by email."},"subscriptions":{"$ref":"#/components/schemas/CustomerSubscriptionsField"},"rgpd_consent":{"type":["boolean","null"],"description":"GDPR consent flag."},"color_id":{"type":["integer","null"],"description":"Customer color ID."},"notary_id":{"type":["integer","null"],"description":"Notary customer ID.","example":123456789},"check_duplicate":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omitted: silently updates an existing duplicate and returns its ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": returns HTTP 409 when a duplicate is found."},"children":[]}]}]}]}],"example":true},"firstname":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"lastname":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"user_id":{"type":["integer","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assigned_user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"type_id":{"type":["integer","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current_situation_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/SearchCustomerRequest":{"id":"components/schemas/SearchCustomerRequest","kind":"json-schema","title":"SearchCustomerRequest","data":{"type":"object","description":"Search filters. All fields are optional. When no filters are provided,\nreturns all customers in scope (paginated).\n","properties":{"first_name":{"type":["string","null"],"description":"Filter by first name (partial match).","example":"Jean"},"last_name":{"type":["string","null"],"description":"Filter by last name (partial match).","example":"Dupont"},"email":{"type":["string","null"],"description":"Filter by email (exact match).","example":"jean.dupont@example.com"},"phone":{"type":["string","null"],"description":"Filter by phone number (partial match).","example":"0601010101"},"agency_id":{"type":["integer","null"],"description":"Filter by agency ID.","example":263961},"group_id":{"type":["integer","null"],"description":"Filter by customer group ID.","example":1},"origin_id":{"type":["integer","null"],"description":"Filter by customer origin ID.","example":12},"per_page":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Number of results per page. Maximum 200.","example":25},"cursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque pagination cursor from the previous response's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit for the first page."},"children":[]}]}]}]},"firstname":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"lastname":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/CustomerGroupResponse":{"id":"components/schemas/CustomerGroupResponse","kind":"json-schema","title":"CustomerGroupResponse","data":{"type":"object","properties":{"id":{"type":"integer","description":"Group ID.","example":1},"name":{"type":"string","description":"Group display name.","example":"Demandeur"}}}},"components/schemas/CustomerConsentResponse":{"id":"components/schemas/CustomerConsentResponse","kind":"json-schema","title":"CustomerConsentResponse","data":{"type":"object","description":"Active cold-calling consent for the customer.","properties":{"reason":{"type":"string","description":"Reason/motive for the consent.","example":"Accord verbal lors de la visite"},"accept_outside_hours":{"type":"boolean","description":"Whether the customer accepts being contacted outside business hours.","example":true},"consent_date":{"type":["string","null"],"format":"date-time","description":"Date when consent was given.","example":"2026-06-15T10:00:00+02:00"},"proofs":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof files stored in cloud storage."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /mods/immocloud/files/download?type=contact&customer_id={id}&folder={folder}&file={file}"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to download a proof file."},"children":[]}]}]}],"items":{"type":"object","properties":{"folder":{"type":"string","description":"Cloud storage folder path.","example":"Private/Consentement"},"file":{"type":"string","description":"Filename in cloud storage.","example":"formulaire-signe-668a3f2e1b4c7.pdf"}}}}}}},"components/schemas/SearchCriteriaResponse":{"id":"components/schemas/SearchCriteriaResponse","kind":"json-schema","title":"SearchCriteriaResponse","data":{"type":"object","description":"A single search criterion.","properties":{"id":{"type":["integer","null"],"description":"Criteria ID."},"operator":{"type":["string","null"],"description":"Comparison operator (e.g. EGAL, SUPERIEUR, CONTIENT)."},"value":{"description":"Value(s). A string, or an array of strings for multi-value criteria.\n"}}}},"components/schemas/SearchPolygonResponse":{"id":"components/schemas/SearchPolygonResponse","kind":"json-schema","title":"SearchPolygonResponse","data":{"type":"object","description":"A geographic search polygon.","properties":{"type":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search type (time | distance | free)."},"children":[]}]}]}]},"mode":{"type":["string","null"],"description":"Travel mode."},"start":{"type":["string","null"],"description":"Starting point."},"value":{"type":["integer","null"],"description":"Value in km or minutes."},"polygon":{"description":"Polygon coordinates."}}}},"components/schemas/SearchRequestResponse":{"id":"components/schemas/SearchRequestResponse","kind":"json-schema","title":"SearchRequestResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A customer search request. Reference fields ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intended_use"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason_for_purchase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current_resale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeframe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id, label}"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"objects loaded on demand. Response keys follow "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snake_case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; camelCase"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"keys are deprecated."},"children":[]}]}]}],"properties":{"id":{"type":"integer"},"name":{"type":["string","null"]},"comment":{"type":["string","null"]},"is_active":{"type":"boolean"},"has_email_alert":{"type":"boolean"},"has_sms_alert":{"type":"boolean"},"intended_use":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intended use ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id, label}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"reason_for_purchase":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for purchase ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id, label}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"current_resale":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current resale ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id, label}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"timeframe":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timeframe ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id, label}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"criteria":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search criteria (internal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPRIS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" bounding rows excluded)."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SearchCriteriaResponse"}},"key_points":{"type":"object","description":"Key points split into pros and cons.","properties":{"pros":{"type":"array","items":{"$ref":"#/components/schemas/SearchCriteriaResponse"}},"cons":{"type":"array","items":{"$ref":"#/components/schemas/SearchCriteriaResponse"}}}},"polygons":{"type":"array","items":{"$ref":"#/components/schemas/SearchPolygonResponse"}},"isActive":{"type":"boolean","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"hasEmailAlert":{"type":"boolean","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_email_alert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"hasSmsAlert":{"type":"boolean","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_sms_alert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"createdAt":{"type":["string","null"],"format":"date-time","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"updatedAt":{"type":["string","null"],"format":"date-time","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/CustomerRelationResponse":{"id":"components/schemas/CustomerRelationResponse","kind":"json-schema","title":"CustomerRelationResponse","data":{"type":"object","description":"A customer linked to another customer.\n","properties":{"id":{"type":"integer","description":"ID of the related customer.","example":123456789},"first_name":{"type":["string","null"],"example":"Marie"},"last_name":{"type":["string","null"],"example":"Dupont"},"business_name":{"type":["string","null"],"description":"Company name of the related customer (for professional customer)."},"role":{"type":"object","description":"Role of the related customer within the relationship.","properties":{"id":{"type":"integer","description":"Role list value ID (liste 17).","example":29},"label":{"type":"string","example":"Épouse"}}},"keep_informed":{"type":"boolean","description":"Whether this related customer should be kept informed.","example":true},"is_joint_ownership":{"type":"boolean","description":"Whether the relationship is a joint ownership (indivision).","example":false},"joint_ownership":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Joint ownership details, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the relationship is not a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"joint ownership."},"children":[]}]}]}],"properties":{"share_percent":{"type":["string","null"],"description":"Ownership share (percentage).","example":"50"}}}}}},"components/schemas/CustomerResponse":{"id":"components/schemas/CustomerResponse","kind":"json-schema","title":"CustomerResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer details. Optional relations are loaded via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and are absent from the response otherwise."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response keys follow "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"snake_case"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Some camelCase keys are still returned but"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deprecated (see the changelog); use their snake_case equivalents."},"children":[]}]}]}],"properties":{"id":{"type":"integer","description":"Unique customer identifier.","example":789},"gender":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender details (or the raw gender code when not loaded). Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=gender"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"first_name":{"type":["string","null"],"example":"Jean"},"last_name":{"type":["string","null"],"example":"Dupont"},"business_name":{"type":["string","null"],"description":"Company name (for professional customers)."},"firstname":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"lastname":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"companyName":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"email":{"type":["string","null"],"example":"jean.dupont@example.com"},"phones":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone numbers (read-only). Each entry has a stable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (1-4), the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id, label}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag. Empty"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"slots are omitted."},"children":[]}]}]}],"items":{"type":"object","properties":{"slot":{"type":"integer","description":"Phone slot (1-4).","example":1},"number":{"type":["string","null"],"example":"+33201010101"},"type":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"description":"Phone type ID."},"label":{"type":["string","null"],"description":"Phone type label."}}},"stop_sms":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS opt-out flag for this number. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=stopSms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"phone":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}],"example":"+33201010101"},"mobilePhone":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}],"example":"+33601010101"},"origin":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer acquisition origin. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=origin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"assigned_user":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigned negotiator. Full object when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", otherwise "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ id }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no negotiator is assigned."},"children":[]}]}]}]},"created_by":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creator of the customer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ id }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or full object with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if none."},"children":[]}]}]}]},"agency":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agency. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=agency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"next_contact_at":{"type":["string","null"],"format":"date-time","description":"Date of the next planned contact."},"reference":{"type":["string","null"],"description":"Internal reference of the customer."},"created_via":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical creation channel ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id, label}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"informations":{"type":"object","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_via"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"comments":{"type":["string","null"],"description":"Free-text comments about the customer."},"current_situation":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current situation of the customer ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id, label}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"type":{"type":["integer","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current_situation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"groups":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer groups. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CustomerGroupResponse"}},"address":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer addresses. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object"}},"color":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer color ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"newsletter":{"type":["boolean","null"],"description":"Newsletter subscription flag."},"subscriptions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alert subscriptions. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object"}},"rgpd_consent":{"type":"boolean","description":"GDPR consent flag (customers.rgpd column)."},"rgpd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GDPR consent data. Loaded with include=rgpd."},"children":[]}]}]}]},"consent":{"$ref":"#/components/schemas/CustomerConsentResponse"},"created_at":{"type":["string","null"],"format":"date-time","example":"2025-01-15T10:30:00+01:00"},"updated_at":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"updatedAt":{"type":["string","null"],"format":"date-time","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"notary":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notary customer. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=notary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"mandate":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registered mandates. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=mandate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object"}},"website":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client area access ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_access_granted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_login_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"login_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=website"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"search_requests":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search requests. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=searchRequests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SearchRequestResponse"}},"relations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related customers. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=relations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CustomerRelationResponse"}},"typeProject":{"type":"object","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Moved to the search request level ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intended_use"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"stopSms":{"type":"object","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=stopSms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"searchRequests":{"type":"array","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search_requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object"}}}}},"components/schemas/CursorPaginationMeta-2":{"id":"components/schemas/CursorPaginationMeta-2","kind":"json-schema","title":"CursorPaginationMeta-2","data":{"type":"object","description":"Pagination metadata for cursor-based listings.","properties":{"per_page":{"type":"integer","description":"Number of items returned per page.","example":50},"next_cursor":{"type":["string","null"],"description":"Cursor to pass in the next request to fetch the next page.\nNull when there is no next page.\n","example":"eyJpZCI6MTIzfQ=="},"prev_cursor":{"type":["string","null"],"description":"Cursor for the previous page. Null on first page."}}}},"components/schemas/CursorPaginationLinks-2":{"id":"components/schemas/CursorPaginationLinks-2","kind":"json-schema","title":"CursorPaginationLinks-2","data":{"type":"object","description":"Ready-to-use links for cursor-based navigation.","properties":{"next":{"type":["string","null"],"description":"URL of the next page, or null."},"prev":{"type":["string","null"],"description":"URL of the previous page, or null."}}}},"components/schemas/CustomerOriginResponse":{"id":"components/schemas/CustomerOriginResponse","kind":"json-schema","title":"CustomerOriginResponse","data":{"type":"object","properties":{"id":{"type":"integer","description":"Origin ID.","example":12},"label":{"type":"string","description":"Origin display label.","example":"Site internet"}}}},"components/schemas/UpdateCustomerRequest":{"id":"components/schemas/UpdateCustomerRequest","kind":"json-schema","title":"UpdateCustomerRequest","data":{"type":"object","description":"Partial update of a customer. Only provided fields are modified.\n","properties":{"gender":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer gender code. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /users/genders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for available values."},"children":[]}]}]}],"example":"m"},"first_name":{"type":["string","null"],"example":"Jean"},"last_name":{"type":["string","null"],"example":"Dupont"},"business_name":{"type":["string","null"],"description":"Company name (for professional customers)."},"email":{"type":["string","null"],"format":"email","description":"Customer email address.","example":"new.email@example.com"},"phones":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone numbers, one entry per slot (1-4). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identifies the position; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_sms"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CustomerPhoneBody"}},"phone":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array (slot 1)."},"children":[]}]}]}],"example":"+33201020304"},"mobile_phone":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array (slot 3)."},"children":[]}]}]}],"example":"+33601020304"},"origin_id":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer origin ID. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /customers/origins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":12},"assigned_user_id":{"type":["integer","null"],"description":"Assigned negotiator (agent) ID.","example":123456},"agency_id":{"type":["integer","null"],"description":"Agency ID (within the authenticated site's scope) to reassign the customer to.","example":123456},"next_contact_at":{"type":["string","null"],"format":"date-time"},"reference":{"type":["string","null"],"description":"Internal reference of the customer."},"comments":{"type":["string","null"],"description":"Internal notes"},"current_situation_id":{"type":["integer","null"],"description":"Current situation list value ID (liste 5)."},"group":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer group ID. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /customers/groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":2},"groups":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of customer group IDs. Takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"integer"},"example":[2,4]},"address":{"$ref":"#/components/schemas/CustomerAddressBody"},"newsletter":{"type":["boolean","null"],"description":"Whether or not the customer agrees to receive communications by email."},"subscriptions":{"$ref":"#/components/schemas/CustomerSubscriptionsField"},"rgpd_consent":{"type":["boolean","null"],"description":"GDPR consent flag."},"color_id":{"type":["integer","null"],"description":"Customer color ID."},"notary_id":{"type":["integer","null"],"description":"Notary customer ID.","example":123456789},"firstname":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"lastname":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"user_id":{"type":["integer","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assigned_user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"type_id":{"type":["integer","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current_situation_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"product_id":{"type":["integer","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Product to associate via a follow-up."},"children":[]}]}]}],"example":123456789}}}},"components/schemas/UpdateCustomerConsentRequest":{"id":"components/schemas/UpdateCustomerConsentRequest","kind":"json-schema","title":"UpdateCustomerConsentRequest","data":{"type":"object","required":["reason"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for creating or updating cold-calling consent."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" encoding when attaching proof files."},"children":[]}]}]}],"properties":{"reason":{"type":"string","maxLength":64,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason/motive for the consent (e.g. \"Accord verbal\", \"Formulaire signé\")."},"children":[]}]}]}],"example":"Accord verbal lors de la visite"},"accept_outside_hours":{"type":"boolean","description":"Whether the customer accepts being contacted outside business hours.","example":true},"proofs":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof files (scanned documents, signed forms, etc.)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files are uploaded to the customer's cloud storage under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Documents confidentiels/Consentement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subfolder."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" content type."},"children":[]}]}]}],"items":{"type":"string","format":"binary"}},"consent_date":{"type":["string","null"],"format":"date-time","description":"Date when consent was given. ISO 8601 format.\nDefaults to current date/time when omitted.\n","example":"2026-06-15T10:00:00+02:00"}}}},"components/schemas/CreateSearchRequestBody":{"id":"components/schemas/CreateSearchRequestBody","kind":"json-schema","title":"CreateSearchRequestBody","data":{"type":"object","required":["criteria"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a search request (buyer search criteria) for a customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criterias/search-requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover available criteria for your site."},"children":[]}]}]}],"properties":{"name":{"type":["string","null"],"description":"Label for the search request.","example":"Apartment T3 Paris 15 budget 400k"},"comment":{"type":["string","null"],"description":"Internal note about this search request.","example":"Client flexible on surface, priority is location near metro"},"is_active":{"type":["boolean","null"],"description":"Whether the search request is active.","example":true},"has_email_alert":{"type":["boolean","null"],"description":"Send email alerts when matching properties are found.","example":true},"has_sms_alert":{"type":["boolean","null"],"description":"Send SMS alerts when matching properties are found.","example":false},"intended_use_id":{"type":["integer","null"],"description":"Intended use."},"reason_for_purchase_id":{"type":["integer","null"],"description":"Reason-for-purchase list value ID (liste 35)."},"current_resale_id":{"type":["integer","null"],"description":"Current-resale list value ID (liste 77)."},"timeframe_id":{"type":["integer","null"],"description":"Timeframe list value ID (liste 4)."},"keyword":{"type":["string","null"],"deprecated":true},"wording":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"alertEmail":{"type":["boolean","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_email_alert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"alertSms":{"type":["boolean","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_sms_alert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"criteria":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of search criteria. Each criterion has an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operators:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operator"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example use"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EGAL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equals (exact match)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction type, property category"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPERIEUR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Greater than or equal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Min surface, min rooms"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFERIEUR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Less than or equal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max price, max floor"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTIENT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains (multi-value)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zones, cities"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DIFFERENT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not equal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exclude a type"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common criteria IDs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criterias/search-requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list):"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"27"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Property category"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIQUE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"28"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIQUE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"65"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postcode City"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEXT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NUMBER"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"33"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of rooms"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NUMBER"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"34"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Living area (m²)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NUMBER"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"38"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bedrooms"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NUMBER"},"children":[]}]}]}]}]}]}],"items":{"type":"object","required":["id","operator","value"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria ID (numeric string or XML key)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criterias/search-requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list available IDs."},"children":[]}]}]}],"example":"27"},"operator":{"type":"string","enum":["CONTIENT","SUPERIEUR","INFERIEUR","EGAL","DIFFERENT"],"description":"Comparison operator.","example":"EGAL"},"value":{"description":"Value to compare. Format depends on criteria type.\nFor operator \"CONTIENT\", multiple values can be comma-separated.\n","example":"1"}}},"example":[{"id":"27","operator":"EGAL","value":"1"},{"id":"28","operator":"EGAL","value":"Vente"},{"id":"30","operator":"INFERIEUR","value":"400000"},{"id":"33","operator":"EGAL","value":"3"},{"id":"65","operator":"EGAL","value":"75015 PARIS"}]}}}},"components/schemas/UpdateSearchRequestBody":{"id":"components/schemas/UpdateSearchRequestBody","kind":"json-schema","title":"UpdateSearchRequestBody","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update. Only provided fields are modified."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, it "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replaces"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the entire criteria list (not merged)."},"children":[]}]}]}],"properties":{"name":{"type":["string","null"],"description":"Label for the search request.","example":"Apartment T3 Paris 15 budget 400k"},"comment":{"type":["string","null"],"description":"Internal note about this search request.","example":"Client flexible on surface, priority is location near metro"},"is_active":{"type":["boolean","null"],"description":"Whether the search request is active.","example":true},"has_email_alert":{"type":["boolean","null"],"description":"Send email alerts when matching properties are found.","example":true},"has_sms_alert":{"type":["boolean","null"],"description":"Send SMS alerts when matching properties are found.","example":false},"intended_use_id":{"type":["integer","null"],"description":"Intended use."},"reason_for_purchase_id":{"type":["integer","null"],"description":"Reason-for-purchase list value ID (liste 35)."},"current_resale_id":{"type":["integer","null"],"description":"Current-resale list value ID (liste 77)."},"timeframe_id":{"type":["integer","null"],"description":"Timeframe list value ID (liste 4)."},"keyword":{"type":["string","null"],"deprecated":true},"wording":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"alertEmail":{"type":["boolean","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_email_alert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"alertSms":{"type":["boolean","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_sms_alert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"criteria":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replacement criteria array. Same format as create."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" all existing criteria when provided."},"children":[]}]}]}],"items":{"type":"object","required":["id","operator","value"],"properties":{"id":{"type":"string"},"operator":{"type":"string","enum":["CONTIENT","SUPERIEUR","INFERIEUR","EGAL","DIFFERENT"]},"value":{"description":"Value depends on criteria type."}}}}}}},"components/schemas/FollowUpResponse":{"id":"components/schemas/FollowUpResponse","kind":"json-schema","title":"FollowUpResponse","data":{"type":"object","description":"A follow-up links a customer to a product they are interested in.","properties":{"customerId":{"type":"integer","description":"Customer ID.","example":789},"productId":{"type":"integer","description":"Product ID.","example":12345},"opinion":{"type":"object","description":"Agent's opinion on the match.","properties":{"value":{"type":["integer","null"]},"text":{"type":["string","null"]}}},"rating":{"type":["integer","null"],"minimum":0,"maximum":5,"description":"Customer interest rating (0-5).","example":4},"visibleCustomer":{"type":["boolean","null"],"description":"Whether the follow-up is visible to the customer (portal)."},"updatedAt":{"type":["string","null"],"format":"date-time","description":"Last update timestamp."},"progress":{"type":["string","null"],"description":"Follow-up progress label."}}}},"components/schemas/UpdateFollowUpRequest":{"id":"components/schemas/UpdateFollowUpRequest","kind":"json-schema","title":"UpdateFollowUpRequest","data":{"type":"object","description":"Update fields for a follow-up.","properties":{"rating":{"type":"integer","minimum":0,"maximum":5,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer interest rating for this product (0 = not rated, 1-5 scale)."},"children":[]}]}]}],"example":4}}}},"components/schemas/ActionResponse":{"id":"components/schemas/ActionResponse","kind":"json-schema","title":"ActionResponse","data":{"type":"object","description":"A logged commercial action (call, visit, email, etc.).","properties":{"id":{"type":"integer","description":"Action log entry ID.","example":98765},"name":{"type":["string","null"],"description":"Action type description/label.","example":"Appel sortant"},"date_performed":{"type":["string","null"],"format":"date-time","description":"Date when the action was performed.","example":"2026-01-15T14:30:00+01:00"},"result":{"type":["string","null"],"description":"Action result/comment.","example":"Client intéressé"},"user_id":{"type":["integer","null"],"description":"Agent who performed the action.","example":456}}}},"components/schemas/LeadCustomer":{"id":"components/schemas/LeadCustomer","kind":"json-schema","title":"LeadCustomer","data":{"type":"object","required":["email"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer data for the lead. Uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"snake_case"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field names."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate detection is performed on email OR phone OR mobile_phone."},"children":[]}]}]}],"properties":{"firstname":{"type":["string","null"],"description":"Customer first name.","example":"Marie"},"lastname":{"type":["string","null"],"description":"Customer last name.","example":"Martin"},"email":{"type":"string","format":"email","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer email address. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used (along with phone and mobile_phone) for duplicate detection."},"children":[]}]}]}],"example":"marie.martin@example.com"},"phone":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number. International format recommended (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+33601020304"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validated with libphonenumber."},"children":[]}]}]}],"example":"+33698765432"},"phone2":{"type":["string","null"],"description":"Secondary phone number."},"mobile_phone":{"type":["string","null"],"description":"Mobile phone number.","example":"+33611223344"},"mobile_phone2":{"type":["string","null"],"description":"Secondary mobile phone."},"fax":{"type":["string","null"],"description":"Fax number."},"gender":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer gender code. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /users/genders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover available values."},"children":[]}]}]}],"example":"F"},"group":{"type":["integer","null"],"description":"Customer group ID. Seller leads accept groups in families 4,5,6,7,10,11,12.\nBuyer leads accept groups in families 1,2,3,8,9.\nIf omitted, defaults to group 2 (seller) or 1 (buyer).\n","example":4},"groups":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of customer group IDs (when multiple groups apply)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when both are provided."},"children":[]}]}]}],"items":{"type":"integer"},"example":[4,5]},"origin":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer origin ID. When omitted, the system auto-assigns the origin"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configured for the API client (partner)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /customers/origins"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list available origins."},"children":[]}]}]}],"example":12},"address":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Street address (number + street)."},"children":[]}]}]}],"example":"10 rue des Lilas"},"address_complement":{"type":["string","null"],"description":"Address complement (building, floor, etc.)."},"postalcode":{"type":["string","null"],"description":"Postal code.","example":"69001"},"city":{"type":["string","null"],"description":"City name.","example":"Lyon"},"country":{"type":["string","null"],"description":"Country code (ISO).","example":"FR"},"residence":{"type":["string","null"],"description":"Residence/building name."},"latitude":{"type":["string","null"],"description":"Contact address latitude (decimal degrees as string).","example":"45.7640"},"longitude":{"type":["string","null"],"description":"Contact address longitude (decimal degrees as string).","example":"4.8357"},"next_contact":{"type":["string","null"],"format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suggested next contact date (format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"model":{"type":["string","null"],"description":"External customer reference (your system's ID)."},"comment2":{"type":["string","null"],"description":"Internal comment."},"newsletter":{"type":["boolean","null"],"description":"Whether the customer is subscribed to the newsletter."},"rgpd":{"type":["boolean","null"],"description":"GDPR consent flag."},"password":{"type":["string","null"],"description":"Customer portal password (for web access)."},"status":{"type":["boolean","null"],"description":"Customer active status."}}}},"components/schemas/CreateSellerLeadRequest":{"id":"components/schemas/CreateSellerLeadRequest","kind":"json-schema","title":"CreateSellerLeadRequest","data":{"type":"object","required":["agency_id","customer"],"properties":{"agency_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target agency ID. Must be among the agencies accessible from the authenticated"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"site. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /agencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available IDs."},"children":[]}]}]}],"example":123},"user_id":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigned user (agent) ID. When omitted, the system uses the configured"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lead distribution rule ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEFAULT_LEADS_AFFECTATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to automatically assign"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a user within the target agency."},"children":[]}]}]}],"example":456},"check_duplicate":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls duplicate behavior:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omitted (default): if a duplicate customer is found by email OR phone OR mobile_phone,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the existing contact is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"silently updated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and linked to the product."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": returns HTTP 409 with error code "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when a duplicate is found."},"children":[]}]}]}]}]},"customer":{"$ref":"#/components/schemas/LeadCustomer"},"product_id":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing product ID to link the seller lead to. Mutually exclusive with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object — provide one or the other, not both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product must exist and be within the site scope."},"children":[]}]}]}],"example":99999},"product":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product to create (required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria follow the same rules as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts either the XML key (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"TypeBien\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or numeric ID (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"27\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format depends on criteria type (see Products documentation)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DPE auto-calculated, GPS auto-geocoded (see Products pack for details)"},"children":[]}]}]}]}],"properties":{"model":{"type":["string","null"],"description":"Product reference. Auto-generated if omitted.\nUse this to store your own reference for cross-system mapping.\n"},"criteria":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of criteria for the new product. At minimum, include the mandatory"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"criteria for your site (typically "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TypeBien"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TypeTransaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"items":{"type":"object","required":["id","value"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria identifier. Accepts either the XML key (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"TypeBien\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Surface\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"conso_energ\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or the numeric ID (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"27\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"TypeBien"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria value. Format depends on criteria type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIQUE: exact value code string (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"Appartement\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NUMBER: numeric value as string (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"85.5\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FLAG: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEXT: free text"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MULTIPLE: array of value code strings"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DATE: ISO 8601 datetime or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dd/MM/yyyy"},"children":[]}]}]}]}],"example":"Maison"}}}},"rooms":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Room list for the new product. Each room has a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (validated against"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referential list 1), optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surface"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"niveau"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sol"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /configs/listes/1/values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover room types."},"children":[]}]}]}],"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Room type from referential list 1.","example":"Chambre"},"surface":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Room surface in m²."},"children":[]}]}]}],"example":14.5},"niveau":{"type":["number","null"],"description":"Floor level."},"exposition":{"type":["string","null"],"description":"Exposure from referential list 2."},"vue":{"type":["string","null"],"description":"View from referential list 3."},"sol":{"type":["string","null"],"description":"Floor type from referential list 4."},"commentaire":{"type":["string","null"],"description":"Free-text comment."}}}},"descriptions":{"type":["array","null"],"description":"Descriptive texts for the product (multilingual).","items":{"type":"object","properties":{"title":{"type":["string","null"],"description":"Short title."},"description":{"type":["string","null"],"description":"Full description."},"language_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 639-2 language code (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"fr\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"fr"}}}}}}}}},"components/schemas/LeadSearchRequest":{"id":"components/schemas/LeadSearchRequest","kind":"json-schema","title":"LeadSearchRequest","data":{"type":"object","description":"A search request defines what the buyer is looking for. It contains\ncriteria with operators that define the search parameters.\n","properties":{"wording":{"type":["string","null"],"description":"Display label for the search request.","example":"Appartement T3 Lyon centre"},"name":{"type":["string","null"],"description":"Internal name/identifier for the search request."},"activated":{"type":["boolean","null"],"description":"Whether the search request is active. When active, the system\nruns automatic matching against new properties.\n","default":true},"alert_email":{"type":["boolean","null"],"description":"Send email alerts when matching properties are found."},"alert_sms":{"type":["boolean","null"],"description":"Send SMS alerts when matching properties are found."},"type_projet_id":{"type":["integer","null"],"description":"Project type ID (e.g. primary residence, rental investment).\nSite-specific configuration.\n"},"motif_achat":{"type":["string","null"],"description":"Purchase motivation (validated against referential list 35)."},"timeframe":{"type":["string","null"],"description":"Purchase timeframe (validated against referential list 4)."},"keyword":{"type":["string","null"],"description":"Free-text keyword for the search."},"comment":{"type":["string","null"],"description":"Internal comment on the search request."},"criteria":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of search criteria. Each criterion has an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operators:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operator"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example use"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EGAL"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equals (exact match)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction type, property category"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPERIEUR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Greater than or equal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Min surface, min rooms"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INFERIEUR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Less than or equal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Max price, max floor"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTIENT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains (for multi-value)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zones, cities"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DIFFERENT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not equal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exclude a type"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criterias/search-requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover available criteria IDs for your site."},"children":[]}]}]}],"items":{"type":"object","required":["id","operator","value"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria ID (numeric string or XML key)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criterias/search-requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list available IDs."},"children":[]}]}]}],"example":"27"},"operator":{"type":"string","enum":["CONTIENT","SUPERIEUR","INFERIEUR","EGAL","DIFFERENT"],"description":"Comparison operator.","example":"SUPERIEUR"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value to compare. Type depends on criteria:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NUMBER: numeric string (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"3\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"55\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TEXT: string"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIQUE/FLAG: value code"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For zones, multiple values can be comma-separated."},"children":[]}]}]}]}],"example":"2"}}},"example":[{"id":"TypeBien","operator":"EGAL","value":"Appartement"},{"id":"NbPieces","operator":"SUPERIEUR","value":"2"},{"id":"Prix","operator":"INFERIEUR","value":"300000"}]},"polygons":{"type":["array","null"],"description":"Geographic polygon filters. Each polygon defines a search zone\nas an array of coordinate points.\n","items":{"type":"object","properties":{"polygon":{"type":"array","description":"Array of coordinate points defining the polygon boundary.","items":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"}}}}}}}}}},"components/schemas/CreateBuyerLeadRequest":{"id":"components/schemas/CreateBuyerLeadRequest","kind":"json-schema","title":"CreateBuyerLeadRequest","data":{"type":"object","required":["agency_id","customer"],"properties":{"agency_id":{"type":"integer","description":"Target agency ID. Must be within the authenticated site's scope.\n","example":123},"user_id":{"type":["integer","null"],"description":"Assigned user (agent) ID. When omitted, auto-assigned via the configured\nlead distribution rule.\n","example":456},"check_duplicate":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same duplicate behavior as seller leads:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/omitted: silently updates existing duplicate"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": returns 409 on duplicate"},"children":[]}]}]}]}]},"customer":{"$ref":"#/components/schemas/LeadCustomer"},"search_request":{"type":["array","null"],"description":"One or more search requests to create for the buyer. Each defines\nthe buyer's search criteria (what they are looking for).\n","items":{"$ref":"#/components/schemas/LeadSearchRequest"}},"product_id":{"type":["integer","null"],"description":"Existing product ID to follow. When provided, the buyer is linked to\nthis product via a follow-up action. Optional.\n","example":12345},"comment":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text comment attached to the follow-up action (only used when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided)."},"children":[]}]}]}],"example":"Client très intéressé, rappeler rapidement"}}}},"components/schemas/SearchTransactionRequest":{"id":"components/schemas/SearchTransactionRequest","kind":"json-schema","title":"SearchTransactionRequest","data":{"type":"object","description":"Search filters for sale transactions. All fields are optional.\nWhen no filters are provided, returns all transactions in scope.\n","properties":{"keyword":{"type":["string","null"],"description":"Free text search across customer names, product model, dossier number.\n","example":"Dupont"},"is_without_product":{"type":["boolean","null"],"description":"When true, returns only transactions without a linked product."},"offer_status":{"type":["string","null"],"enum":["refusee","attente","annulee","acceptee",null],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by offer status. Only applicable for sales-offers search."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attente"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"acceptee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Accepted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refusee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Refused"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"annulee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Cancelled"},"children":[]}]}]}]}]},"product_model":{"type":["string","null"],"description":"Filter by product reference (exact or partial match).","example":"REF-2025-001"},"seller_firstname":{"type":["string","null"],"description":"Filter by seller first name (partial match)."},"seller_lastname":{"type":["string","null"],"description":"Filter by seller last name (partial match)."},"seller_email":{"type":["string","null"],"description":"Filter by seller email."},"buyer_firstname":{"type":["string","null"],"description":"Filter by buyer first name (partial match)."},"buyer_lastname":{"type":["string","null"],"description":"Filter by buyer last name (partial match)."},"buyer_email":{"type":["string","null"],"description":"Filter by buyer email."},"agency_ids":{"type":["array","null"],"description":"Filter by agency IDs. Each ID must be within the authenticated site's scope.\n","items":{"type":"integer"},"example":[123,456]},"user_ids":{"type":["array","null"],"description":"Filter by assigned user (agent) IDs.","items":{"type":"integer"},"example":[789]},"last_modified":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only return transactions modified after this date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: ISO 8601 with timezone offset ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:MM:SS+HH:MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"2025-01-01T00:00:00+01:00"},"last_created":{"type":["string","null"],"format":"date-time","description":"Only return transactions created after this date.\nFormat: ISO 8601 with timezone offset.\n","example":"2025-06-01T00:00:00+02:00"},"is_only_ids":{"type":["boolean","null"],"description":"When true, returns only transaction IDs (lighter response)."},"per_page":{"type":"integer","minimum":1,"maximum":200,"default":25,"description":"Number of results per page. Maximum 200.\n","example":50},"cursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque pagination cursor. Pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"previous response to fetch the next page. Omit for the first page."},"children":[]}]}]}]},"sort_type":{"type":["string","null"],"enum":["id","created_at","updated_at",null],"description":"Field used to sort results."},"sort_order":{"type":["string","null"],"enum":["asc","desc",null],"description":"Sort direction.","default":"desc"},"include":{"type":["string","null"],"description":"Comma-separated relations to eagerly load in the response.\nSee endpoint description for available includes.\n","example":"buyer,seller,fees"}}}},"components/schemas/SaleTransactionResponse":{"id":"components/schemas/SaleTransactionResponse","kind":"json-schema","title":"SaleTransactionResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sale transaction (compromis, offer, or lease). Fields availability depends"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the transaction type and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}],"properties":{"id":{"type":"integer","description":"Unique identifier of the transaction.","example":5678},"status":{"type":"object","description":"Current status of the transaction.","properties":{"id":{"type":"integer","description":"Status ID (from referential list 7)."},"label":{"type":"string","description":"Localized status label.","example":"Actée"}}},"offer_status":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current state of the offer (for sales-offers only):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attente"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"acceptee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Accepted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refusee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Refused"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"annulee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiree"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Expired"},"children":[]}]}]}]}],"enum":["attente","acceptee","refusee","annulee","expiree",null]},"number":{"type":["string","null"],"description":"Agreement dossier number.","example":"COMP-2025-001"},"transaction_type":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of transaction ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Vente"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"Vente"},"product_id":{"type":["integer","null"],"description":"ID of the linked product (property listing).","example":12345},"customer_id":{"type":["integer","null"],"description":"ID of the buyer/tenant contact.","example":789},"seller_id":{"type":["integer","null"],"description":"ID of the seller/landlord contact.","example":790},"created_at":{"type":["string","null"],"format":"date-time","description":"Transaction creation date.","example":"2025-03-01T10:00:00+01:00"},"updated_at":{"type":["string","null"],"format":"date-time","description":"Last modification date.","example":"2025-06-01T14:30:00+02:00"},"date_agreement":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compromise signature date (date SSP — Signature Sous Seing Privé)."},"children":[]}]}]}],"example":"2025-03-15T00:00:00+01:00"},"date_act":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deed signing date (date de signature de l'acte authentique)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"effective sale date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used for reporting."},"children":[]}]}]}],"example":"2025-06-01T00:00:00+02:00"},"date_cancellation":{"type":["string","null"],"format":"date-time","description":"Cancellation date, when applicable."},"buyer_price":{"type":["number","null"],"format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual buyer price (property price + agency fees)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the total amount paid by the buyer."},"children":[]}]}]}],"example":355000},"product_price":{"type":["number","null"],"format":"float","description":"Property net price (seller price, excluding agency fees).\n","example":350000},"agencies":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agency details. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=agencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"buyer":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer contact details. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=buyer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"seller":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seller contact details. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=seller"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fees":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee breakdown. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=fees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object"}},"followed_nego":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agent following the transaction. Loaded with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=followed_nego"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/CursorPaginationMeta-3":{"id":"components/schemas/CursorPaginationMeta-3","kind":"json-schema","title":"CursorPaginationMeta-3","data":{"type":"object","description":"Pagination metadata for cursor-based listings.","properties":{"per_page":{"type":"integer","description":"Number of items returned per page.","example":25},"next_cursor":{"type":["string","null"],"description":"Cursor to pass in the next request to fetch the next page.\nNull when there is no next page (last page reached).\n","example":"eyJpZCI6MTIzfQ=="},"prev_cursor":{"type":["string","null"],"description":"Cursor to fetch the previous page. Null when on the first page."}}}},"components/schemas/CursorPaginationLinks-3":{"id":"components/schemas/CursorPaginationLinks-3","kind":"json-schema","title":"CursorPaginationLinks-3","data":{"type":"object","description":"Ready-to-use links for cursor-based navigation.","properties":{"next":{"type":["string","null"],"description":"URL of the next page, or null when there is none."},"prev":{"type":["string","null"],"description":"URL of the previous page, or null when there is none."}}}},"components/schemas/UpdateTransactionRequest":{"id":"components/schemas/UpdateTransactionRequest","kind":"json-schema","title":"UpdateTransactionRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only billing/invoicing fields are updatable via this endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale price ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and dates ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date_act"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date_agreement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read-only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Site API context."},"children":[]}]}]}],"properties":{"conformity":{"type":["integer","null"],"minimum":0,"maximum":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conformity status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Not verified"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Conform"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Non-conform"},"children":[]}]}]}]}]},"c_discount_seller":{"type":["integer","null"],"description":"Commercial discount amount for seller (in cents or currency unit)."},"c_discount_buyer":{"type":["integer","null"],"description":"Commercial discount amount for buyer."},"no_facture_buyer":{"type":["integer","null"],"description":"Buyer invoice number (legacy numeric field)."},"no_facture_seller":{"type":["integer","null"],"description":"Seller invoice number (legacy numeric field)."},"num_bill_buyer":{"type":["string","null"],"description":"Buyer invoice reference (free-text).","example":"FA-2025-001"},"num_credit_note_buyer":{"type":["string","null"],"description":"Buyer credit note reference."},"num_bill_seller":{"type":["string","null"],"description":"Seller invoice reference.","example":"FA-2025-002"},"num_credit_note_seller":{"type":["string","null"],"description":"Seller credit note reference."},"billing_status":{"type":["integer","null"],"description":"Billing workflow status. Values depend on the site configuration.\n"},"payment_amount":{"type":["integer","null"],"description":"Total payment amount received (in currency unit).","example":15000},"amount_recovered":{"type":["integer","null"],"description":"Amount already recovered/collected."},"payment_date":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when payment was received."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: ISO 8601 with timezone offset ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:MM:SS+HH:MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"2025-06-01T00:00:00+02:00"},"date_bill_buyer":{"type":["string","null"],"format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer invoice date (format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"2025-06-05"},"date_credit_note_buyer":{"type":["string","null"],"format":"date","description":"Buyer credit note date."},"date_bill_seller":{"type":["string","null"],"format":"date","description":"Seller invoice date.","example":"2025-06-05"},"date_credit_note_seller":{"type":["string","null"],"format":"date","description":"Seller credit note date."},"fees":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee percentage updates. Each entry must reference an existing fee "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the transaction's fee records."},"children":[]}]}]}],"items":{"type":"object","required":["id","percentage"],"properties":{"id":{"type":"integer","description":"ID of the existing fee record to update."},"percentage":{"type":"number","format":"float","minimum":0,"maximum":100,"description":"Fee percentage (0 to 100).","example":5}}}}}}},"components/schemas/UserResponse":{"id":"components/schemas/UserResponse","kind":"json-schema","title":"UserResponse","data":{"type":"object","description":"User (agent/collaborator) details. Some fields are only populated when\nthe user has data for them; null otherwise.\n","properties":{"id":{"type":"integer","description":"Unique user identifier.","example":582602},"firstname":{"type":["string","null"],"example":"Marie"},"lastname":{"type":["string","null"],"example":"Martin"},"gender":{"type":["string","null"],"description":"Gender code (m, f, s, etc.).","example":"f"},"sexe":{"type":["string","null"],"description":"Sexe label (legacy field)."},"is_rsac_displayed":{"type":["boolean","null"],"description":"Whether the RSAC number is displayed publicly."},"ai_consent":{"type":"boolean","description":"Whether the user consented to AI features."},"editor_code":{"type":["string","null"],"description":"Network/editor code this user belongs to."},"picture":{"type":["string","null"],"description":"Profile picture URL."},"signature":{"type":["string","null"],"description":"Signature picture URL."},"email":{"type":["string","null"],"example":"marie.martin@agence.fr"},"phone":{"type":["string","null"],"description":"Office phone number.","example":"+33498765432"},"mobile_phone":{"type":["string","null"],"description":"Mobile phone number.","example":"+33698765432"},"site_code":{"type":["string","null"],"description":"Primary site code."},"rsac_number":{"type":["string","null"],"description":"RSAC registration number (commercial agent)."},"description":{"type":["string","null"],"description":"Public bio/description."},"delegation":{"type":["boolean","null"],"description":"Whether delegation is enabled."},"status":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1=Active, 0=Archived, 3=Hidden/Deleted"},"children":[]}]}]}],"example":1},"rsac_city":{"type":["string","null"],"description":"RSAC registration city."},"production_ratio":{"type":["number","null"],"description":"Production ratio (performance metric)."},"ip_filter":{"type":["string","null"],"description":"IP address whitelist for this user."},"group_id":{"type":["integer","null"],"description":"Primary permission group ID.","example":2},"group_id2":{"type":["integer","null"],"description":"Secondary permission group ID."},"last_login_date":{"type":["string","null"],"format":"date-time","description":"Last login timestamp.","example":"2026-06-15T08:30:00+02:00"},"is_email_valid":{"type":["boolean","null"],"description":"Whether the email has been validated."},"color":{"type":["string","null"],"description":"Calendar color code (hex)."},"experience":{"type":["string","null"],"description":"Years of experience or experience description."},"career_path":{"type":["string","null"]},"specialty":{"type":["string","null"],"description":"Professional specialty."},"zimbra_login":{"type":["string","null"],"description":"Zimbra email login."},"zimbra_alias":{"type":["string","null"],"description":"Zimbra email alias."},"agency_id":{"type":["integer","null"],"description":"Primary agency ID.","example":123},"agencies_list":{"type":["string","null"],"description":"Comma-separated list of accessible agency IDs.","example":"123,456"},"agencies_list_affectation":{"type":["string","null"],"description":"Comma-separated list of lead affectation agency IDs."},"is_visible_directory":{"type":"boolean","description":"Whether the user is visible in the public agency directory."},"professional_liability_number":{"type":["string","null"],"description":"Professional liability insurance number."},"professional_liability_organization":{"type":["string","null"],"description":"Insurance organization name."},"professional_liability_address":{"type":["string","null"],"description":"Insurance organization address."},"jestimo_login":{"type":["string","null"],"description":"Jestimo (valuation tool) login."},"jestimo_password":{"type":["string","null"],"description":"Jestimo password."},"user_types":{"type":"array","items":{"type":"integer"},"description":"List of user type IDs (professional roles).","example":[1]},"logs":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recent action log entries for this user."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loaded only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include=logs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is requested."},"children":[]}]}]}],"items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":["string","null"],"description":"Action type label."},"date_performed":{"type":["string","null"],"format":"date-time"}}}}}}},"components/schemas/CreateUserRequest":{"id":"components/schemas/CreateUserRequest","kind":"json-schema","title":"CreateUserRequest","data":{"type":"object","required":["firstname","lastname","email","status","agency_id","password","group_id"],"description":"Request body for creating a new user.","properties":{"firstname":{"type":"string","description":"User first name.","example":"Marie"},"lastname":{"type":"string","description":"User last name.","example":"Martin"},"email":{"type":"string","format":"email","description":"User email address. Must be unique across the site.\nUsed for login and notifications.\n","example":"marie.martin@agence.fr"},"password":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User password. Must meet RGPD requirements:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Length: 12-40 characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must contain: uppercase, lowercase, digit, special character"},"children":[]}]}]}]}],"example":"S3cur3P@ss!2026"},"status":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Archived (cannot login)"},"children":[]}]}]}]}],"example":1},"agency_id":{"type":"integer","description":"Primary agency ID for the user. Must be within the authenticated site's scope.\n","example":123},"agencies_list":{"type":["array","null"],"description":"Additional agency IDs the user has access to (multi-agency access).\nEach must be within the site scope.\n","items":{"type":"integer"},"example":[123,456]},"group_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permission group ID. Determines access level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /users/groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover available groups."},"children":[]}]}]}],"example":2},"delegation":{"type":["boolean","null"],"description":"Whether the user can delegate their work to others."},"phone":{"type":["string","null"],"description":"Office phone number.","example":"+33498765432"},"mobile_phone":{"type":["string","null"],"description":"Mobile phone number.","example":"+33698765432"},"gender":{"type":["string","null"],"enum":["m","f","s"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender code. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /users/genders"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list."},"children":[]}]}]}],"example":"f"},"user_types":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User type IDs (professional roles). A user can have multiple types."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /users/types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover available types."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1]}}}},"components/schemas/UpdateUserRequest":{"id":"components/schemas/UpdateUserRequest","kind":"json-schema","title":"UpdateUserRequest","data":{"type":"object","description":"Partial user update. Only provided fields are modified.\n","properties":{"firstname":{"type":["string","null"]},"lastname":{"type":["string","null"]},"email":{"type":["string","null"],"format":"email"},"password":{"type":["string","null"],"description":"New password (same RGPD requirements as create)."},"status":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 = Active, 0 = Archived"},"children":[]}]}]}]},"agency_id":{"type":["integer","null"],"description":"Change primary agency."},"agencies_list":{"type":["array","null"],"items":{"type":"integer"}},"group_id":{"type":["integer","null"]},"delegation":{"type":["boolean","null"]},"phone":{"type":["string","null"]},"mobile_phone":{"type":["string","null"]},"gender":{"type":["string","null"]},"user_types":{"type":["array","null"],"items":{"type":"integer"}}}}},"components/schemas/UserGroupResponse":{"id":"components/schemas/UserGroupResponse","kind":"json-schema","title":"UserGroupResponse","data":{"type":"object","description":"A user permission group.","properties":{"id":{"type":"integer","description":"Group ID.","example":1},"name":{"type":"string","description":"Group display name.","example":"Administrateur"},"delegation":{"type":"boolean","description":"Whether users in this group can delegate work."}}}},"components/schemas/UserTypeResponse":{"id":"components/schemas/UserTypeResponse","kind":"json-schema","title":"UserTypeResponse","data":{"type":"object","description":"A professional role type.","properties":{"id":{"type":"integer","description":"Type ID.","example":1},"name":{"type":"string","description":"Type name (masculine).","example":"Négociateur"},"name_female":{"type":["string","null"],"description":"Type name (feminine form).","example":"Négociatrice"}}}},"components/schemas/GenderResponse":{"id":"components/schemas/GenderResponse","kind":"json-schema","title":"GenderResponse","data":{"type":"object","description":"A gender option.","properties":{"id":{"type":"string","description":"Gender code (used in create/update requests).","example":"m"},"description":{"type":"string","description":"Full label.","example":"Monsieur"},"description_legal":{"type":["string","null"],"description":"Legal form description."},"abbreviation":{"type":["string","null"],"description":"Short abbreviation.","example":"M."},"sexe":{"type":["string","null"],"description":"Sexe indicator."},"is_entity":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether this gender represents a legal entity (company/société)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, the contact is a professional/company, not a person."},"children":[]}]}]}]},"private":{"type":"boolean","description":"Whether this gender is for internal use only."}}}},"components/schemas/WebhookResponse":{"id":"components/schemas/WebhookResponse","kind":"json-schema","title":"WebhookResponse","data":{"type":"object","description":"A registered webhook subscription.","properties":{"id":{"type":"integer","description":"Unique webhook identifier.","example":42},"url":{"type":"string","format":"uri","description":"Target URL that receives webhook payloads via HTTP POST.","example":"https://portail.example.com/webhook"},"headers":{"type":["object","null"],"description":"Custom headers sent with each webhook payload request.\nUse this to authenticate incoming webhook requests on your server.\n","example":{"X-Api-Key":"secret"}},"authId":{"type":["integer","null"],"description":"ID of the linked webhook auth configuration (if any)."},"format":{"type":["string","null"],"description":"Custom format identifier for the payload (if any)."},"origines":{"type":"array","items":{"type":"string"},"description":"List of subscribed event types. Only events in this list trigger\na delivery to the target URL.\n","example":["CUSTOMER_CREATE","PRODUCT_UPDATE"]}}}},"components/schemas/CreateWebhookRequest":{"id":"components/schemas/CreateWebhookRequest","kind":"json-schema","title":"CreateWebhookRequest","data":{"type":"object","required":["url","origines"],"description":"Request body for creating a new webhook subscription.","properties":{"url":{"type":"string","format":"uri","description":"HTTPS URL that will receive webhook payloads via POST.\nMust be publicly accessible and respond within 10 seconds.\n","example":"https://portail.example.com/webhook"},"origines":{"type":"array","items":{"type":"string"},"description":"Event types to subscribe to. Each value is validated against the list\nof available hook origins for the site. Invalid values return 422.\n","example":["CUSTOMER_CREATE","CUSTOMER_UPDATE","PRODUCT_CREATE","PRODUCT_UPDATE"]},"headers":{"type":["object","null"],"description":"Custom key-value headers to include in every webhook HTTP request.\nUseful for authentication (e.g. API keys).\n","example":{"X-Api-Key":"secret"}},"auth_id":{"type":["integer","null"],"description":"ID of a webhook auth configuration to use for request authentication."},"format":{"type":["string","null"],"description":"Custom format identifier for the payload structure."}}}},"components/schemas/UpdateWebhookRequest":{"id":"components/schemas/UpdateWebhookRequest","kind":"json-schema","title":"UpdateWebhookRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update fields for a webhook. All fields are optional — only provided fields"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are modified."},"children":[]}]}]}],"properties":{"url":{"type":["string","null"],"format":"uri","description":"New target URL.","example":"https://new-portail.example.com/webhook"},"origines":{"type":["array","null"],"items":{"type":"string"},"description":"Updated list of event types (replaces the current list entirely).","example":["CUSTOMER_CREATE","PRODUCT_UPDATE","PRODUCT_DELETE"]},"headers":{"type":["object","null"],"description":"Updated custom headers (replaces entirely).","example":{"X-Api-Key":"new-secret"}},"auth_id":{"type":["integer","null"],"description":"Updated webhook auth configuration ID."},"format":{"type":["string","null"],"description":"Updated format identifier."}}}},"components/schemas/ListeValue":{"id":"components/schemas/ListeValue","kind":"json-schema","title":"ListeValue","data":{"type":"object","description":"A single value entry in a referential list.","properties":{"id":{"type":"integer","description":"Value ID (used in API requests to reference this value).","example":1},"name":{"type":"string","description":"Display label.","example":"Chambre"},"order":{"type":"integer","description":"Sort order for display.","example":1}}}},"components/schemas/Liste":{"id":"components/schemas/Liste","kind":"json-schema","title":"Liste","data":{"type":"object","description":"A referential list with its values.","properties":{"id":{"type":"integer","description":"List ID.","example":1},"values":{"type":"array","description":"Available values in this list.","items":{"$ref":"#/components/schemas/ListeValue"}}}}},"components/schemas/EventTypeResponse":{"id":"components/schemas/EventTypeResponse","kind":"json-schema","title":"EventTypeResponse","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the event type, used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value when creating events"},"children":[]}]}]}],"example":"12"},"key":{"type":"string","description":"Stable key of the event type.","example":"VISIT"},"label":{"type":"string","description":"Display name of the event type.","example":"Visite"},"color":{"type":["string","null"],"description":"Hexadecimal color used to display events of this type.","example":"#5B2D8E"},"booking_behavior":{"type":["string","null"],"description":"Indicates how online appointment booking behaves for this event type."},"displayed":{"type":"boolean","description":"Whether this event type is shown in the agency interface."},"event_form":{"type":"object","description":"Form layout for this event type. Returned only when form information is available.\n","properties":{"fields":{"type":"array","description":"Keys of the fields displayed on the event form.","items":{"type":"string"}},"collapsed_fields":{"type":"array","description":"Keys of the fields hidden by default (shown only when the form is expanded).","items":{"type":"string"}}}}}}},"components/schemas/CursorPaginationMeta-4":{"id":"components/schemas/CursorPaginationMeta-4","kind":"json-schema","title":"CursorPaginationMeta-4","data":{"type":"object","description":"Pagination metadata for cursor-based listings.","properties":{"per_page":{"type":"integer","description":"Number of items returned per page.","example":50},"next_cursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor to pass as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch the next page. Null when there is no next page."},"children":[]}]}]}],"example":"eyJpZCI6MTIzfQ=="},"prev_cursor":{"type":["string","null"],"description":"Cursor to fetch the previous page. Null when there is no previous page."}}}},"components/schemas/HourMinute":{"id":"components/schemas/HourMinute","kind":"json-schema","title":"HourMinute","data":{"type":"object","description":"A time of day expressed as hours and minutes.","properties":{"hours":{"type":"integer","minimum":0,"maximum":23,"description":"Hour of the day (0-23)."},"minutes":{"type":"integer","minimum":0,"maximum":59,"description":"Minutes (0-59)."}}}},"components/schemas/DayTimeSlot":{"id":"components/schemas/DayTimeSlot","kind":"json-schema","title":"DayTimeSlot","data":{"type":"object","description":"A time range within a day.","properties":{"start":{"$ref":"#/components/schemas/HourMinute"},"end":{"$ref":"#/components/schemas/HourMinute"}}}},"components/schemas/PermanenceTimeframeResponse":{"id":"components/schemas/PermanenceTimeframeResponse","kind":"json-schema","title":"PermanenceTimeframeResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client reception (permanence) slots, grouped by day of week"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Each day holds a list of time ranges."},"children":[]}]}]}],"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/DayTimeSlot"}},"example":{"MO":[{"start":{"hours":9,"minutes":0},"end":{"hours":12,"minutes":0}}],"TU":[]}}},"components/schemas/PermanenceUserResponse":{"id":"components/schemas/PermanenceUserResponse","kind":"json-schema","title":"PermanenceUserResponse","data":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"Start of the permanence slot, formatted in the requested timezone.","example":"2026-01-15T09:00:00+01:00"},"end":{"type":"string","format":"date-time","description":"End of the permanence slot, formatted in the requested timezone.","example":"2026-01-15T12:00:00+01:00"},"user_id":{"type":["integer","null"],"description":"Identifier of the user assigned to the slot."}}}},"components/schemas/WorkingTimeResponse":{"id":"components/schemas/WorkingTimeResponse","kind":"json-schema","title":"WorkingTimeResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Working time slots grouped by day of week. Each day key ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") holds the list of time ranges worked that day."},"children":[]}]}]}],"properties":{"MO":{"type":"array","items":{"$ref":"#/components/schemas/DayTimeSlot"}},"TU":{"type":"array","items":{"$ref":"#/components/schemas/DayTimeSlot"}},"WE":{"type":"array","items":{"$ref":"#/components/schemas/DayTimeSlot"}},"TH":{"type":"array","items":{"$ref":"#/components/schemas/DayTimeSlot"}},"FR":{"type":"array","items":{"$ref":"#/components/schemas/DayTimeSlot"}},"SA":{"type":"array","items":{"$ref":"#/components/schemas/DayTimeSlot"}},"SU":{"type":"array","items":{"$ref":"#/components/schemas/DayTimeSlot"}}}}},"components/schemas/AvailabilitySlot":{"id":"components/schemas/AvailabilitySlot","kind":"json-schema","title":"AvailabilitySlot","data":{"type":"object","description":"A free slot during which the user is available, derived from their working\ntime minus their existing events.\n","properties":{"start":{"type":"string","format":"date-time","description":"Start of the available slot, formatted in the requested timezone."},"end":{"type":"string","format":"date-time","description":"End of the available slot, formatted in the requested timezone."}}}},"components/schemas/SharedAgendaResponse":{"id":"components/schemas/SharedAgendaResponse","kind":"json-schema","title":"SharedAgendaResponse","data":{"type":"object","properties":{"user_id":{"type":"string","description":"Identifier of the user whose agenda is accessible.","example":"42"},"firstname":{"type":["string","null"],"description":"First name of the user."},"lastname":{"type":["string","null"],"description":"Last name of the user."},"email":{"type":["string","null"],"description":"Email address of the user."},"status":{"type":"object","description":"Visibility status of the user's agenda.","properties":{"is_archived":{"type":"boolean","description":"True when the user is archived."},"is_hidden":{"type":"boolean","description":"True when the user is hidden (archived or deleted)."}}}}}},"components/schemas/EventParticipantResponse":{"id":"components/schemas/EventParticipantResponse","kind":"json-schema","title":"EventParticipantResponse","data":{"type":"object","properties":{"ext_user_id":{"type":"integer","description":"Identifier of the participating user (agent)."},"is_creator":{"type":"boolean","description":"True for the participant who created the event."},"is_organizer":{"type":"boolean","description":"True for the participant who owns/hosts the event."}}}},"components/schemas/EventResponse":{"id":"components/schemas/EventResponse","kind":"json-schema","title":"EventResponse","data":{"type":"object","description":"A calendar event. The set of populated fields depends on the event type and\non the information supplied when the event was created.\n","properties":{"id":{"type":"integer","description":"Unique identifier of the event."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type key (matches the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of an entry from the event types list)."},"children":[]}]}]}],"example":"VISIT"},"starts_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event start, UTC datetime ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:MM:SSZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"2026-01-15T09:00:00Z"},"ends_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event end, UTC datetime ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:MM:SSZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"2026-01-15T10:00:00Z"},"all_day":{"type":"boolean","description":"True when the event lasts the whole day and the time portion is not significant."},"title":{"type":["string","null"],"description":"Title displayed on the event."},"location":{"type":["string","null"],"description":"Address or place where the event takes place."},"location_geo":{"type":["object","null"],"description":"Geographic coordinates of the location, when known.","properties":{"lat":{"type":"number","description":"Latitude in decimal degrees.","example":48.8566},"lng":{"type":"number","description":"Longitude in decimal degrees.","example":2.3522}}},"sequence_duration":{"type":["integer","null"],"description":"Duration of a single booking slot, in minutes."},"gathering_gauge":{"type":["integer","null"],"description":"Maximum number of attendees that can book the same slot."},"commute_duration":{"type":["integer","null"],"description":"Travel time reserved before the event, in minutes."},"communicate_location":{"type":["boolean","null"],"description":"Whether the location may be shared with attendees."},"is_confidential":{"type":["boolean","null"],"description":"When true, the event details are hidden from non-participants; the slot still shows as busy."},"remind_time_in_min":{"type":["integer","null"],"description":"Reminder lead time before the event start, in minutes."},"appointment_mode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the appointment is conducted:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OFFICE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": at the agency office"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": by phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": on-site at the property"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VISIO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": video conference"},"children":[]}]}]}]}],"enum":["OFFICE","PHONE","PRODUCT","VISIO",null]},"participants":{"type":"array","description":"Users (agents) attending the event.","items":{"$ref":"#/components/schemas/EventParticipantResponse"}},"products":{"type":"array","description":"Property listings linked to the event.","items":{"type":"object","properties":{"ext_product_id":{"type":"string","description":"Identifier of the linked property listing."},"ext_domain_id":{"type":"string","description":"Identifier of the domain the listing belongs to."}}}},"contacts":{"type":"array","description":"Contacts (customers) linked to the event.","items":{"type":"object","properties":{"ext_contact_id":{"type":"string","description":"Identifier of the linked contact."},"ext_domain_id":{"type":"string","description":"Identifier of the domain the contact belongs to."}}}},"notes":{"type":["string","null"],"description":"Free-text notes attached to the event."},"visio_url":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the video-conference room (used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment_mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VISIO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"immo360_organizer_url":{"type":["string","null"],"description":"Link used by the agent to host the live/virtual visit."},"immo360_participation_url":{"type":["string","null"],"description":"Link shared with attendees to join the live/virtual visit."},"archived":{"type":["boolean","null"],"description":"True when the event has been archived (hidden from default listings but restorable)."},"parent_id":{"type":["integer","null"],"description":"Identifier of the parent event when this entry is an occurrence of a recurring series."},"recurrence":{"type":["object","null"],"description":"Recurrence definition of the event, when it is part of a recurring series."}}}},"components/schemas/EventParticipantInput":{"id":"components/schemas/EventParticipantInput","kind":"json-schema","title":"EventParticipantInput","data":{"type":"object","required":["user_id","is_creator","is_organizer"],"properties":{"user_id":{"type":"integer","description":"Identifier of the participating user (agent). Must be unique within the\nparticipants list.\n"},"is_creator":{"type":"boolean","description":"Marks the participant who created the event. Exactly one participant in the\nlist must have this set to true.\n"},"is_organizer":{"type":"boolean","description":"Marks the participant who owns/hosts the event (its primary agenda).\nExactly one participant in the list must have this set to true.\n"}}}},"components/schemas/EventRecurrence":{"id":"components/schemas/EventRecurrence","kind":"json-schema","title":"EventRecurrence","data":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"iCalendar RRULE-style recurrence definition. When present, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dtstart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freq"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"by*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" arrays follow the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc5545"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 5545"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" recurrence semantics."},"children":[]}]}]}],"required":["dtstart","freq","interval"],"properties":{"dtstart":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First occurrence start, UTC datetime in format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:MM:SSZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-01-15T09:00:00Z"},"freq":{"type":"string","description":"Recurrence frequency.","enum":["yearly","monthly","weekly","daily","hourly","minutely","secondly"]},"interval":{"type":"integer","minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Interval between occurrences in units of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freq"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freq: weekly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval: 2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = every two weeks)."},"children":[]}]}]}]},"count":{"type":["integer","null"],"minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of occurrences to generate. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"until"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"until":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date of the recurrence (inclusive), UTC "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:MM:SSZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-12-31T23:59:59Z"},"bymonth":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Months of the year the event applies to (1 = January … 12 = December)."},"children":[]}]}]}],"items":{"type":"integer","minimum":1,"maximum":12}},"bymonthday":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Days of the month (1..31, or negative to count from the end of the month,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. -1 = last day)."},"children":[]}]}]}],"items":{"type":"integer","minimum":-31,"maximum":31}},"bynmonthday":{"type":["array","null"],"description":"Negative-indexed days of the month (counted from the end).","items":{"type":"integer"}},"byyearday":{"type":["array","null"],"description":"Days of the year (1..366, or negative from the end of the year).","items":{"type":"integer","minimum":-366,"maximum":366}},"byweekno":{"type":["array","null"],"description":"ISO week numbers of the year (1..53, or negative from the end).","items":{"type":"integer","minimum":-53,"maximum":53}},"byweekday":{"type":["array","null"],"description":"Days of the week the event recurs on, as two-letter codes\n(MO, TU, WE, TH, FR, SA, SU).\n","items":{"type":"string","enum":["MO","TU","WE","TH","FR","SA","SU"]}},"bynweekday":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ordinal weekday rules as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[weekday_index, position]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pairs, where"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"weekday_index is 0=Monday … 6=Sunday and position is the occurrence within"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the month (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[1, 2]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = the second Tuesday). Used for monthly-by-day patterns."},"children":[]}]}]}],"items":{"type":"array","items":{"type":"integer"}}},"bysetpos":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selects the Nth occurrence(s) within the set produced by the other "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"by*"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rules (e.g. -1 = the last matching day of the period)."},"children":[]}]}]}],"items":{"type":"integer"}},"exdate":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exception dates to exclude from the generated series, each a UTC datetime"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:MM:SSZ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","example":"2026-02-15T09:00:00Z"}}}}},"components/schemas/CreateEventRequest":{"id":"components/schemas/CreateEventRequest","kind":"json-schema","title":"CreateEventRequest","data":{"type":"object","required":["type","starts_at","ends_at","all_day"],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type identifier as returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /calendar/events/types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the behavior and the available form fields for the event."},"children":[]}]}]}],"example":"\"7\" = visit"},"starts_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event start, UTC datetime in strict format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:MM:SSZ"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(the trailing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required)."},"children":[]}]}]}],"example":"2026-01-15T09:00:00Z"},"ends_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event end, UTC datetime in strict format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:MM:SSZ"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(the trailing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required). Must be after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starts_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-01-15T10:00:00Z"},"all_day":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, the event spans the whole day(s) and the time portion of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starts_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ends_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ignored by calendar displays."},"children":[]}]}]}]},"title":{"type":["string","null"],"description":"Free-text title shown on the event. Falls back to the event type label when null."},"location":{"type":["string","null"],"description":"Human-readable address or place where the event takes place."},"location_geo":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geographic coordinates of the event location. When provided, both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lat"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lng"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required."},"children":[]}]}]}],"required":["lat","lng"],"properties":{"lat":{"type":"number","description":"Latitude in decimal degrees.","example":48.8566},"lng":{"type":"number","description":"Longitude in decimal degrees.","example":2.3522}}},"sequence_duration":{"type":["integer","null"],"description":"Duration of a single appointment slot in minutes, used when the event type\nallows online booking with successive time slots (e.g. open-house sequences).\n"},"gathering_gauge":{"type":["integer","null"],"description":"Maximum number of attendees that can book the same slot (capacity).\nUsed for group/open-house style appointments.\n"},"commute_duration":{"type":["integer","null"],"description":"Estimated travel time to the location, in minutes, reserved before the event\nfor the agent's commute.\n"},"communicate_location":{"type":["boolean","null"],"description":"Whether the event location may be shared with the attendees/contacts."},"is_confidential":{"type":["boolean","null"],"description":"When true, event details are hidden from users who are not participants;\nthe slot still appears as busy.\n"},"remind_time_in_min":{"type":["integer","null"],"minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lead time of the reminder before the event start, in minutes"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. 15 = remind 15 minutes before). 0 disables the offset."},"children":[]}]}]}]},"appointment_mode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the appointment is conducted:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OFFICE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": at the agency office"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": by phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRODUCT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": on-site at the property"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VISIO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": video conference"},"children":[]}]}]}]}],"enum":["OFFICE","PHONE","PRODUCT","VISIO",null]},"participants":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Users (agents) attending the event. Exactly one must have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_organizer: true"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and exactly one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_creator: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be unique."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/EventParticipantInput"}},"products":{"type":["array","null"],"description":"Immofacile product (property listing) IDs linked to the event.\nEach ID must be within the client update scope.\n","items":{"type":"integer"}},"contacts":{"type":["array","null"],"description":"Immofacile customer (contact) IDs linked to the event.","items":{"type":"integer"}},"notes":{"type":["string","null"],"description":"Free-text internal notes attached to the event."},"visio_url":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of the video-conference room (used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment_mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VISIO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"immo360_organizer_url":{"type":["string","null"],"description":"Link used by the agent to host the live/virtual visit."},"immo360_participation_url":{"type":["string","null"],"description":"Link shared with attendees to join the live/virtual visit."},"archived":{"type":["boolean","null"],"description":"Whether the event is created in an archived (hidden) state."},"parent_id":{"type":["integer","null"],"description":"ID of the parent event when this event is an occurrence/child of a\nrecurring series.\n"},"recurrence":{"$ref":"#/components/schemas/EventRecurrence"}}}},"components/schemas/UpdateEventRequest":{"id":"components/schemas/UpdateEventRequest","kind":"json-schema","title":"UpdateEventRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update of an event. Every top-level field is optional; only the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provided fields are modified. Field meanings are identical to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreateEventRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (see that schema for full descriptions)."},"children":[]}]}]}],"properties":{"type":{"type":["string","null"]},"starts_at":{"type":["string","null"],"example":"2026-01-15T09:00:00Z"},"ends_at":{"type":["string","null"],"example":"2026-01-15T10:00:00Z"},"all_day":{"type":["boolean","null"]},"title":{"type":["string","null"]},"location":{"type":["string","null"]},"location_geo":{"type":["object","null"],"required":["lat","lng"],"properties":{"lat":{"type":"number"},"lng":{"type":"number"}}},"sequence_duration":{"type":["integer","null"]},"gathering_gauge":{"type":["integer","null"]},"commute_duration":{"type":["integer","null"]},"communicate_location":{"type":["boolean","null"]},"is_confidential":{"type":["boolean","null"]},"remind_time_in_min":{"type":["integer","null"],"minimum":0},"appointment_mode":{"type":["string","null"],"enum":["OFFICE","PHONE","PRODUCT","VISIO",null]},"participants":{"type":["array","null"],"items":{"$ref":"#/components/schemas/EventParticipantInput"}},"products":{"type":["array","null"],"items":{"type":"integer"}},"contacts":{"type":["array","null"],"items":{"type":"integer"}},"notes":{"type":["string","null"]},"visio_url":{"type":["string","null"]},"immo360_organizer_url":{"type":["string","null"]},"immo360_participation_url":{"type":["string","null"]},"archived":{"type":["boolean","null"]},"parent_id":{"type":["integer","null"]},"recurrence":{"$ref":"#/components/schemas/EventRecurrence"}}}},"components/schemas/WebhookEventPayload":{"id":"components/schemas/WebhookEventPayload","kind":"json-schema","title":"WebhookEventPayload","data":{"type":"object","required":["event_type","resource_id","timestamp"],"description":"Payload delivered by Immofacile when a subscribed event occurs.\n","properties":{"event_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event that triggered the notification, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE_ACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" form."},"children":[]}]}]}],"example":"CUSTOMER_CREATE"},"resource_id":{"type":"integer","description":"Identifier of the affected resource.","example":789},"timestamp":{"type":"string","format":"date-time","description":"When the event occurred (RFC 3339).","example":"2026-09-11T14:30:00+02:00"}}}},"schema_70":{"kind":"json-schema","data":{"oneOf":[{"title":"By site","type":"object","required":["site_id"],"properties":{"site_id":{"type":"integer","description":"Numeric site ID to scope the token to.","example":12345}}},{"title":"By agency","type":"object","required":["manufacturer_id"],"properties":{"manufacturer_id":{"type":"integer","description":"Numeric agency (manufacturer) ID to scope the token to. The site will be resolved from the agency.","example":123456}}}]},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"object","properties":{"domain":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base domain to use for all subsequent API calls."},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API base URL is not fixed: use this value as the base"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{domain}/api/v2/site/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). In the Try it console, paste it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"into the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" server variable."},"children":[]}]}]}],"example":"https://v2.immo-facile.com"},"token_type":{"type":"string","enum":["Bearer"]},"expires_in":{"type":"integer","description":"Token lifetime in seconds","example":604800},"access_token":{"type":"string","description":"Bearer token to use in the Authorization header for all subsequent API calls."},"refresh_token":{"type":"string","description":"Token used to obtain a new access token once the current one expires."}}},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"integer"}}}}},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"type":"object","properties":{"criterias":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter criteria. Each item defines a condition on a product criterion."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /criterias/product/all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover available criteria IDs and types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criterias"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the search endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and update ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /products/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criteria"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (without \"s\")."},"children":[]}]}]}],"items":{"type":"object","required":["id","operator","value"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria identifier. Accepts either the XML key (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"TypeBien\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or the numeric ID (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"27\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"TypeBien"},"operator":{"type":"string","enum":["EGAL","DIFFERENT","SUPERIEUR","INFERIEUR","CONTIENT","COMPREND","NE_COMPREND_PAS"],"description":"Comparison operator.","example":"EGAL"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Criteria value. Format depends on criteria type and operator."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be a string or an array of strings (for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONTIENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPREND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators)."},"children":[]}]}]}],"example":"Appartement"}}}},"keyword":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text search. Matches against product reference, address+city,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or owner name. For numeric values, also matches price range (±10%)."},"children":[]}]}]}],"example":"Dupont"},"model":{"type":["string","null"],"description":"Filter by exact product reference.","example":"REF-2025-001"},"customer_id":{"type":["integer","null"],"description":"Filter by owner/seller customer ID.","example":789},"agency_id":{"type":["integer","null"],"description":"Filter by agency ID. Must be within the authenticated site's scope.\n","example":123},"products_admin_id":{"oneOf":[{"type":"array","items":{"type":"integer"}},{"type":"string"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by assigned user (agent) ID(s). Accepts either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of user IDs: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[456, 789]"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A comma-separated string: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"456,789\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters products where the assigned agent matches one of the provided IDs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /users"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover available user IDs."},"children":[]}]}]}],"example":[456,789]},"last_modified":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter products modified on or after this date."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: ISO 8601 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:mm:ss+HH:MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"2026-01-01T00:00:00+01:00"},"status_web":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by web publication status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Only published products"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Only unpublished products"},"children":[]}]}]}]}]},"hasVisit360":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by 360° virtual visit availability:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Only products with a virtual visit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Only products without"},"children":[]}]}]}]}]},"sort_type":{"type":["string","null"],"enum":["id","prix","date","surface","date_added"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort results by:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Product ID (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Price"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Last modification date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surface"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Living area"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date_added"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Creation date"},"children":[]}]}]}]}]},"sort_order":{"type":["string","null"],"enum":["asc","desc"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort direction. Default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":"desc"},"cursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor for pagination (base64-encoded last product ID from previous"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Omit for the first page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are ignored."},"children":[]}]}]}]},"count":{"type":["integer","null"],"maximum":2000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of results per page (offset-based mode). Maximum 2000 for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID-only responses, 100 when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?fetch="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used. Ignored when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}],"default":100}}},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductSummary"}},"next_cursor":{"type":["string","null"]},"has_more":{"type":"boolean"}}},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"type":"object","properties":{"criterias":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same filter criteria as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /products/search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","properties":{"id":{"type":"string"},"operator":{"type":"string"},"value":{}}}},"keyword":{"type":["string","null"]},"model":{"type":["string","null"]},"customer_id":{"type":["integer","null"]},"agency_id":{"type":["integer","null"]},"products_admin_id":{"oneOf":[{"type":"array","items":{"type":"integer"}},{"type":"string"}],"description":"Filter by assigned user (agent) ID(s)."},"last_modified":{"type":["string","null"],"format":"date-time"},"status_web":{"type":["boolean","null"]},"hasVisit360":{"type":["boolean","null"]}}},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer"}}},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"type":"string"},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Product"}}},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Criteria ID"},"value":{"description":"Criteria value (type depends on criteria)"},"label":{"type":["string","null"]}}}}}},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductListItem"}}}},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary"}}},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"type":"object","required":["action_id"],"properties":{"action_id":{"type":"integer","description":"Action type ID (must be active for the site)"},"user_id":{"type":"integer","description":"User (agent) ID who performed the action"},"result":{"type":"string","description":"Action comment/result"},"date_performed":{"type":"string","format":"date-time"}}},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"integer","description":"Product ID"}}}}},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CriteriaResource"}}}},"id":"schema_86"},"schema_87":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CriteriaResource"}}},"id":"schema_87"},"schema_88":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the created or existing customer."}}}}},"id":"schema_88"},"schema_89":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerResponse"}},"meta":{"$ref":"#/components/schemas/CursorPaginationMeta-2"},"links":{"$ref":"#/components/schemas/CursorPaginationLinks-2"}}},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerGroupResponse"}}}},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerOriginResponse"}}}},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CustomerResponse"}}},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the created search request."}}}}},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"type":"integer","default":25,"maximum":200},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FollowUpResponse"}},"meta":{"$ref":"#/components/schemas/CursorPaginationMeta-2"},"links":{"$ref":"#/components/schemas/CursorPaginationLinks-2"}}},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FollowUpResponse"}}},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"type":"integer","default":0},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ActionResponse"}},"next_cursor":{"type":["integer","null"],"description":"Next offset value, or null if no more results."},"has_more":{"type":"boolean","description":"Whether more results are available."}}},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"type":"object","required":["action_id"],"properties":{"action_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action type ID. Must be active for the site."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /actions/types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to discover available action types."},"children":[]}]}]}],"example":15},"user_id":{"type":["integer","null"],"description":"User (agent) ID who performed the action. When omitted,\nno user is associated with the action.\n","example":456},"result":{"type":["string","null"],"description":"Action result/comment (free text).","example":"Client intéressé, rappeler la semaine prochaine"},"date_performed":{"type":["string","null"],"format":"date-time","description":"Date when the action was performed. ISO 8601 format.\nWhen omitted, defaults to now.\n","example":"2026-01-15T14:30:00+01:00"}}},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the created action log entry."}}}}},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"customer_id":{"type":"integer","description":"ID of the created or updated customer."},"product_id":{"type":"integer","description":"ID of the created or linked product."}}}}},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"customer_id":{"type":"integer","description":"ID of the created or updated customer."},"search_request_id":{"type":"array","items":{"type":"integer"},"description":"IDs of the created search requests."}}}}},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SaleTransactionResponse"}},"meta":{"$ref":"#/components/schemas/CursorPaginationMeta-3"},"links":{"$ref":"#/components/schemas/CursorPaginationLinks-3"}}},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SaleTransactionResponse"}}},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer"}},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"type":"integer","default":50,"maximum":200},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}},"meta":{"$ref":"#/components/schemas/CursorPaginationMeta-2"},"links":{"$ref":"#/components/schemas/CursorPaginationLinks-2"}}},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the created user."}}}}},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UserResponse"}}},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserGroupResponse"}}}},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserTypeResponse"}}}},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GenderResponse"}}}},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AgencyResponse"}},"meta":{"$ref":"#/components/schemas/CursorPaginationMeta"},"links":{"$ref":"#/components/schemas/CursorPaginationLinks"}}},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"type":"string","enum":["tag_document"]},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AgencyFullResponse"}}},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookResponse"}}}},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the created webhook."}}}}},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookResponse"}}},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Liste"}}}},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"integer","default":50,"maximum":50},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventTypeResponse"}},"meta":{"$ref":"#/components/schemas/CursorPaginationMeta-4"},"links":{"$ref":"#/components/schemas/CursorPaginationLinks-3"}}},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PermanenceTimeframeResponse"}}},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"string","example":"Europe/Paris"},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$","example":"2026-01-01T00:00:00"},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$","example":"2026-01-07T23:59:59"},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PermanenceUserResponse"}}}},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WorkingTimeResponse"}}},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"integer","example":30},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"},"example":["FREE"]},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AvailabilitySlot"}}}},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SharedAgendaResponse"}}}},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$","example":"2026-01-31T23:59:59"},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"},"example":["1","2"]},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventResponse"}}}},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EventResponse"}}},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"object","required":["archive"],"properties":{"archive":{"type":"boolean","description":"Set to true to archive the event (hidden from default listings but\nkept and restorable), or false to restore a previously archived event.\n"}}},"id":"schema_139"}},"exampleStore":{"paths/~1products~1search/post/requestBody/content/application~1json/example":{"value":{"criterias":[{"id":"TypeBien","operator":"EGAL","value":"Appartement"},{"id":"Prix","operator":"INFERIEUR","value":"400000"},{"id":"Surface","operator":"SUPERIEUR","value":"50"}],"products_admin_id":[456],"sort_type":"date","sort_order":"desc","cursor":null},"id":"paths/~1products~1search/post/requestBody/content/application~1json/example"},"paths/~1products~1{productId}/patch/requestBody/content/application~1json/example":{"value":{"product_id":12345,"criteria":[{"id":"Prix","value":"320000"},{"id":"Surface","value":"92"}],"web_status":true},"id":"paths/~1products~1{productId}/patch/requestBody/content/application~1json/example"},"paths/~1criterias~1zone-list/get/responses/200/content/application~1json/example":{"value":["Paris 1er","Paris 2ème","Lyon 1er","Lyon 2ème"],"id":"paths/~1criterias~1zone-list/get/responses/200/content/application~1json/example"},"paths/~1customers/post/responses/201/content/application~1json/example":{"value":{"data":{"id":789}},"id":"paths/~1customers/post/responses/201/content/application~1json/example"},"paths/~1customers/post/responses/409/content/application~1json/example":{"value":{"error":{"code":"CONFLICT","message":"Duplicate customer found."}},"id":"paths/~1customers/post/responses/409/content/application~1json/example"},"paths/~1customers~1search/post/requestBody/content/application~1json/example":{"value":{"email":"dupont@example.com","per_page":25},"id":"paths/~1customers~1search/post/requestBody/content/application~1json/example"},"paths/~1customers~1groups/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":1,"name":"Demandeur"},{"id":2,"name":"Propriétaire vendeur"},{"id":4,"name":"Propriétaire"}]},"id":"paths/~1customers~1groups/get/responses/200/content/application~1json/example"},"paths/~1customers~1origins/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":12,"label":"Site internet"},{"id":15,"label":"Portail immobilier"}]},"id":"paths/~1customers~1origins/get/responses/200/content/application~1json/example"},"paths/~1customers~1{customerId}~1search-requests/post/responses/201/content/application~1json/example":{"value":{"data":{"id":42}},"id":"paths/~1customers~1{customerId}~1search-requests/post/responses/201/content/application~1json/example"},"paths/~1customers~1{customerId}~1follow-ups~1{productId}/patch/requestBody/content/application~1json/example":{"value":{"rating":4},"id":"paths/~1customers~1{customerId}~1follow-ups~1{productId}/patch/requestBody/content/application~1json/example"},"paths/~1customers~1{customerId}~1actions/post/requestBody/content/application~1json/example":{"value":{"action_id":15,"user_id":456,"result":"Client intéressé, rappeler la semaine prochaine","date_performed":"2026-01-15T14:30:00+01:00"},"id":"paths/~1customers~1{customerId}~1actions/post/requestBody/content/application~1json/example"},"paths/~1customers~1{customerId}~1actions/post/responses/201/content/application~1json/example":{"value":{"data":{"id":98765}},"id":"paths/~1customers~1{customerId}~1actions/post/responses/201/content/application~1json/example"},"paths/~1leads~1sellers/post/requestBody/content/application~1json/example":{"value":{"agency_id":123,"user_id":456,"check_duplicate":true,"customer":{"firstname":"Marie","lastname":"Martin","email":"marie.martin@example.com","phone":"+33698765432","gender":"F","group":4,"address":"10 rue des Lilas","postalcode":"69001","city":"Lyon"},"product":{"criteria":[{"id":"TypeBien","value":"Maison"},{"id":"TypeTransaction","value":"Vente"},{"id":"Surface","value":"120"},{"id":"NbPieces","value":"5"},{"id":"CodePostal","value":"69001"},{"id":"Ville","value":"Lyon"}]}},"id":"paths/~1leads~1sellers/post/requestBody/content/application~1json/example"},"paths/~1leads~1sellers/post/responses/201/content/application~1json/example":{"value":{"data":{"customer_id":789,"product_id":12345}},"id":"paths/~1leads~1sellers/post/responses/201/content/application~1json/example"},"paths/~1leads~1sellers/post/responses/409/content/application~1json/example":{"value":{"error":{"code":"CONFLICT","message":"Duplicate customer found."}},"id":"paths/~1leads~1sellers/post/responses/409/content/application~1json/example"},"paths/~1leads~1buyers/post/requestBody/content/application~1json/example":{"value":{"agency_id":123,"user_id":456,"check_duplicate":false,"customer":{"firstname":"Pierre","lastname":"Durand","email":"pierre.durand@example.com","mobile_phone":"+33611223344","gender":"M","group":1,"address":"5 place Bellecour","postalcode":"69002","city":"Lyon"},"search_request":[{"wording":"Appartement T3 Lyon","activated":true,"alert_email":true,"criteria":[{"id":"TypeBien","operator":"EGAL","value":"Appartement"},{"id":"NbPieces","operator":"SUPERIEUR","value":"2"},{"id":"Prix","operator":"INFERIEUR","value":"300000"},{"id":"Surface","operator":"SUPERIEUR","value":"55"}]}],"comment":"Recherche active, budget flexible"},"id":"paths/~1leads~1buyers/post/requestBody/content/application~1json/example"},"paths/~1leads~1buyers/post/responses/201/content/application~1json/example":{"value":{"data":{"customer_id":790,"search_request_id":[42]}},"id":"paths/~1leads~1buyers/post/responses/201/content/application~1json/example"},"paths/~1leads~1buyers/post/responses/409/content/application~1json/example":{"value":{"error":{"code":"CONFLICT","message":"Duplicate customer found."}},"id":"paths/~1leads~1buyers/post/responses/409/content/application~1json/example"},"paths/~1transactions~1agreement~1search/post/requestBody/content/application~1json/example":{"value":{"product_model":"REF-2025-001","last_modified":"2025-01-01T00:00:00+01:00","per_page":50,"include":"buyer,seller,fees"},"id":"paths/~1transactions~1agreement~1search/post/requestBody/content/application~1json/example"},"paths/~1transactions~1sales-offers~1search/post/requestBody/content/application~1json/example":{"value":{"offer_status":"attente","agency_ids":[123,456],"per_page":25},"id":"paths/~1transactions~1sales-offers~1search/post/requestBody/content/application~1json/example"},"paths/~1transactions~1leases~1search/post/requestBody/content/application~1json/example":{"value":{"agency_ids":[123],"last_created":"2025-06-01T00:00:00+02:00","per_page":25},"id":"paths/~1transactions~1leases~1search/post/requestBody/content/application~1json/example"},"paths/~1agreement~1{compromisId}/get/responses/200/content/application~1json/example":{"value":{"data":{"id":5678,"status":{"id":3,"label":"Actée"},"offer_status":"acceptee","number":"COMP-2025-001","transaction_type":"Vente","product_id":12345,"customer_id":789,"seller_id":790,"created_at":"2025-03-01T10:00:00+01:00","updated_at":"2025-06-01T14:30:00+02:00","date_agreement":"2025-03-15T00:00:00+01:00","date_act":"2025-06-01T00:00:00+02:00","date_cancellation":null,"buyer_price":355000,"product_price":350000}},"id":"paths/~1agreement~1{compromisId}/get/responses/200/content/application~1json/example"},"paths/~1agreement~1{compromisId}/put/requestBody/content/application~1json/example":{"value":{"conformity":1,"billing_status":2,"payment_amount":15000,"payment_date":"2025-06-01T00:00:00+02:00","num_bill_buyer":"FA-2025-001","date_bill_buyer":"2025-06-05","fees":[{"id":1,"percentage":5}]},"id":"paths/~1agreement~1{compromisId}/put/requestBody/content/application~1json/example"},"paths/~1users/post/requestBody/content/application~1json/example":{"value":{"firstname":"Marie","lastname":"Martin","email":"marie.martin@agence.fr","password":"S3cur3P@ss!2026","status":1,"agency_id":123,"group_id":2,"gender":"f","phone":"+33498765432","mobile_phone":"+33698765432","user_types":[1]},"id":"paths/~1users/post/requestBody/content/application~1json/example"},"paths/~1users/post/responses/201/content/application~1json/example":{"value":{"data":{"id":582603}},"id":"paths/~1users/post/responses/201/content/application~1json/example"},"paths/~1users~1{userId}/patch/requestBody/content/application~1json/example":{"value":{"phone":"+33498765000","status":1,"delegation":true},"id":"paths/~1users~1{userId}/patch/requestBody/content/application~1json/example"},"paths/~1users~1groups/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":1,"name":"Administrateur","delegation":true},{"id":2,"name":"Négociateur","delegation":false}]},"id":"paths/~1users~1groups/get/responses/200/content/application~1json/example"},"paths/~1users~1types/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":1,"name":"Négociateur","name_female":"Négociatrice"},{"id":2,"name":"Directeur","name_female":"Directrice"}]},"id":"paths/~1users~1types/get/responses/200/content/application~1json/example"},"paths/~1users~1genders/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":"m","description":"Monsieur","abbreviation":"M.","is_entity":false,"private":false},{"id":"f","description":"Madame","abbreviation":"Mme","is_entity":false,"private":false},{"id":"s","description":"Société","abbreviation":"Sté","is_entity":true,"private":false}]},"id":"paths/~1users~1genders/get/responses/200/content/application~1json/example"},"paths/~1hooks/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":42,"url":"https://portail.example.com/webhook","headers":{"X-Api-Key":"secret"},"authId":null,"format":null,"origines":["CUSTOMER_CREATE","PRODUCT_UPDATE"]}]},"id":"paths/~1hooks/get/responses/200/content/application~1json/example"},"paths/~1hooks/post/requestBody/content/application~1json/example":{"value":{"url":"https://portail.example.com/webhook","origines":["CUSTOMER_CREATE","CUSTOMER_UPDATE","PRODUCT_CREATE","PRODUCT_UPDATE"],"headers":{"X-Api-Key":"my-secret-key"}},"id":"paths/~1hooks/post/requestBody/content/application~1json/example"},"paths/~1hooks/post/responses/201/content/application~1json/example":{"value":{"data":{"id":42}},"id":"paths/~1hooks/post/responses/201/content/application~1json/example"},"paths/~1hooks~1{hookId}/put/requestBody/content/application~1json/example":{"value":{"url":"https://new-portail.example.com/webhook","origines":["CUSTOMER_CREATE","PRODUCT_UPDATE","PRODUCT_DELETE"],"headers":{"X-Api-Key":"new-secret"}},"id":"paths/~1hooks~1{hookId}/put/requestBody/content/application~1json/example"},"paths/customerEvent/post/requestBody/content/application~1json/example":{"value":{"event_type":"CUSTOMER_CREATE","resource_id":789,"timestamp":"2026-09-11T14:30:00+02:00"},"id":"paths/customerEvent/post/requestBody/content/application~1json/example"},"paths/productEvent/post/requestBody/content/application~1json/example":{"value":{"event_type":"PRODUCT_UPDATE","resource_id":12345,"timestamp":"2026-09-11T14:30:00+02:00"},"id":"paths/productEvent/post/requestBody/content/application~1json/example"},"paths/~1configs~1listes~1{listeId}~1values/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":1,"values":[{"id":1,"name":"Chambre","order":1},{"id":2,"name":"Cuisine","order":2},{"id":3,"name":"Salon","order":3}]}]},"id":"paths/~1configs~1listes~1{listeId}~1values/get/responses/200/content/application~1json/example"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"opaque"},"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic Auth with client_id as username and client_secret as password (base64 encoded)"},"children":[]}]}]}]}},"servers":[{"url":"/_mock/openapi","isMockServer":true,"description":"Mock server"},{"url":"{domain}/api/v2/site","variables":{"domain":{"default":"https://v2.immo-facile.com","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base domain returned in the token response ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field)."},"children":[]}]}]}],"enum":["https://v2.immo-facile.com","https://ac3.staging.immo-facile.com","https://ac3.recette1.immo-facile.com"]}}}],"logo":{"imageUrl":"https://public.immo-facile.com/doc-api-v2/logo-orisha.svg","altText":"Orisha Real Estate"},"specType":"openapi"},"options":{"theme":{"colors":{"http":{"get":"#482982","post":"#13aa5b","put":"#ff9a1c","delete":"#d63f3f","patch":"#6947aa"}}},"mockServer":{"url":"/_mock/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Immofacile API V2","description":"# Welcome to the Immofacile API\n\nThis documentation will guide you through integrating with Immofacile, the leading SaaS CRM for real estate agencies. Our REST APIs allow you to connect your applications, automate your business workflows, and extend the power of our ecosystem.\n\n## Target Audience\n\nThis documentation and APIs are designed for three distinct types of users:\n\n- **IT Departments (CIO) of large networks / Franchises:** Who want to interconnect Immofacile with their proprietary internal tools.\n- **Developers / Partners:** Commissioned by our clients to build custom showcase websites or specific business applications.\n- **Software Vendors (PropTech / Ecosystem Partners):** Valuation tools, marketing automation providers, and any type of partner we want to connect to our system.\n- **Real estate listing portals:** Currently fed mostly via CSV or XML feeds, APIs are needed to better manage listing distribution and lead returns.\n\n## 1. API Platform Overview\n\nThe Immofacile API is built on **REST** standards. It uses standard HTTP request methods, explicit HTTP status codes, and a JSON response format.\n\n### 1.1 \"API-First\" Philosophy\n\nTo support the digitalization of real estate agencies, Immofacile offers a bidirectional architecture:\n\n- **Extraction (Read):** Securely access your client data (properties, contacts, events, etc.).\n- **Injection (Write):** Create, update, or enrich the agency database (leads, properties, actions, etc.) while respecting the CRM's business rules.\n\n### 1.2 Environments & Authentication\n\n- **Sandbox (Test):** An isolated environment containing demo data for development without risk of polluting production (coming soon).\n- **Production:** The agency's live environment.\n- **Security:** Authentication relies on the **OAuth 2.0** protocol (via a `Client ID` and `Client Secret` generated from the Immofacile admin dashboard) or by **API Key** for simple internal script integrations.\n\n## 2. Key Concepts & Operating Rules\n\nTo interact effectively with Immofacile, you must understand two core pillars of our architecture: the **Discovery API** for accessing authorized resources, and **Webhooks** for real-time synchronization.\n\n### 2.1 Discovery (Entry Point Discovery)\n\nTo avoid hardcoding URLs and to dynamically adapt to the client agency's access rights, our API implements the **Discovery** principle.\n\n- **The concept:** By querying the single entry point, the API returns the list of all resources you have access to, along with associated URLs and available actions (`GET`, `POST`, etc.).\n- **Example request:** `GET https://api.immofacile.com/v2/`\n\n### 2.2 Webhooks (Real-Time Events)\n\nIntensive polling is prohibited on our platform. To synchronize your data in real time, you must use our **Webhooks** system. Rather than asking Immofacile whether data has changed, Immofacile sends an HTTP `POST` notification to your server as soon as an event occurs.\n\n- **Event format:** Each payload sent by our Webhook contains the event type (`event_type`) and the identifier of the related resource.\n\n## 3. Business Use Cases & Implementation\n\nHere is how to orchestrate our APIs to meet the real-world needs of real estate agents.\n\n### Use Case 1: Create / Update a Lead from an External Tool (Data Write)\n\n- **Step 1:** Duplicate check — Before creating a contact, the third-party application must verify the prospect does not already exist in the agency database via email or phone.\n  - Action: `POST /customers/search` with email criterion\n- **Step 2:** Contact creation — If the contact does not exist, create it.\n  - Action: `POST /customers`\n  - Payload: `{\"firstname\": \"Jean\", \"lastname\": \"Dupont\", \"phone\": \"0601020304\", \"type\": \"Prospect Vendeur\"}`\n- **Step 3:** Search project creation — Create the search project based on the property the contact inquired about.\n- **Step 4:** Add property to contact follow-up — Associate the listing details to the contact so the agent has context during callback.\n\n### Use Case 2: Real-Time Feed for Agency Website / Portal / Partner (Data Read & Webhooks)\n\n- **Step 1:** Initialization (Full Sync) — On first connection, retrieve the entire active catalog.\n- **Step 2:** Listen for updates (Delta Sync via Webhook) — Register the website URL on our webhook to listen for the `property.updated` event.\n  - Action: Configuration via dashboard or `POST /hooks` to subscribe to `property.updated`.\n- **Step 3:** Targeted update — When a price changes or a property is sold in Immofacile, the website receives the webhook. It then queries the specific property to update its local database.\n\n## 4. Support & Escalation\n\n**Having trouble with your integration?**\n\n1. **Check the Logs:** Every error response from our API contains a unique `request_id`.\n2. **Contact dev support:** Send an email to api.imf@orisha.com, always including the `request_id`, the sent payload, and the environment concerned (Sandbox or Prod).\n\n---\n\n## Packs\n\nThe API is organized into packs:\n- **Products** — Property listings management\n- **Customers** — Customer management, search requests, follow-ups, actions\n- **Leads** — Seller and buyer lead creation\n- **Users** — Agent/collaborator management\n- **Agencies** — Agency information\n- **Discovery** — Scope discovery\n- **Webhooks** — Event subscriptions\n\n### Access packs (endpoint badges)\n\nEach endpoint carries one or more colored badges indicating which\nsubscription pack(s) grant access to it. An endpoint may belong to\nseveral packs. Use these badges to check whether your subscription\ncovers a given endpoint.\n\n| Badge | Access pack | Color |\n|-------|-------------|-------|\n| 🟣 **Customers** | Customers, search requests, follow-ups, actions | purple |\n| 🟢 **Properties** | Property listings and criteria | green |\n| 🟠 **Leads** | Seller and buyer lead creation | orange |\n| 🔴 **Sales** | Sale agreements, offers, leases | red |\n| 🟪 **Websites** | Read feeds for websites and portals | blueberry |\n\n## Authentication\n\nObtain a Bearer token via `POST /api/client/token/site` (OAuth2 client credentials).\nInclude it in the `Authorization: Bearer {token}` header for all requests.\n\n**Base URL is dynamic.** The token response includes a `domain` field. Use it\nas the base for every subsequent call (`{domain}/api/v2/site/...`). In the\nTry it console, set the `domain` server variable to that value.\n\n## Error format\n```json\n{ \"error\": { \"code\": \"ERROR_CODE\", \"message\": \"Human-readable message.\" } }\n```\n\n## Pagination\nList endpoints use cursor-based pagination: `next_cursor` + `has_more`.\n\n## Headers\nAll responses include `X-Request-Id` (UUID) for log correlation.\n"}},"baseSlug":"/openapi","routesMapping":{}}