{"items":[{"type":"link","label":"Immofacile API V2","link":"/openapi","routeSlug":"/openapi"},{"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"},{"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"},{"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"},{"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"},{"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"},{"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)"},{"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)"},{"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"},{"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)"},{"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)"},{"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"},{"type":"link","label":"Packs","link":"/openapi/section/welcome-to-the-immofacile-api/packs","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/packs"},{"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)"},{"type":"link","label":"Authentication","link":"/openapi/section/welcome-to-the-immofacile-api/authentication","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/authentication"},{"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"},{"type":"link","label":"Pagination","link":"/openapi/section/welcome-to-the-immofacile-api/pagination","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/pagination"},{"type":"link","label":"Headers","link":"/openapi/section/welcome-to-the-immofacile-api/headers","routeSlug":"/openapi/section/welcome-to-the-immofacile-api/headers"}]},{"type":"separator","label":"API Reference"},{"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."}},"httpPath":"/api/client/token/site"}]},{"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)."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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)."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/products/{productId}/actions"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/criterias/categories/{categoryId}"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/customers/{customerId}/actions"}]},{"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."}},"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."}},"badges":[{"name":"Leads","color":"orange"},{"name":"Websites","color":"blueberry"}],"httpPath":"/leads/buyers"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"badges":[{"name":"Sales","color":"red"}],"httpPath":"/agreement/{compromisId}"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"badges":[{"name":"Access"}],"httpPath":"/users/genders"}]},{"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."}},"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."}},"httpPath":"/agencies/{agencyId}"}]},{"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."}},"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."}},"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)."}},"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."}},"httpPath":"/hooks/{hookId}"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"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)."}},"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)."}},"httpPath":"productEvent"}]},{"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."}},"badges":[{"name":"Properties","color":"green"}],"httpPath":"/configs/listes/{listeId}/values"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/calendar/events/{eventId}/status"}]},{"type":"separator","label":"About"},{"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"},{"type":"link","label":"Added","link":"/openapi/changelog/added","routeSlug":"/openapi/changelog/added"},{"type":"link","label":"Changed","link":"/openapi/changelog/changed","routeSlug":"/openapi/changelog/changed"},{"type":"link","label":"Deprecated","link":"/openapi/changelog/deprecated","routeSlug":"/openapi/changelog/deprecated"},{"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"},{"type":"link","label":"Added","link":"/openapi/changelog/added","routeSlug":"/openapi/changelog/added"}]}]}