Skip to Content

Breaking down methods for Odoo API integration

Updated for Odoo 20
14 May 2026
Last updated: 30 October 2026

Odoo connects to other systems in three main ways: its external API (JSON-2 since Odoo 19, replacing the deprecated XML-RPC and JSON-RPC), REST endpoints built with custom or community modules, and queued middleware for high data volumes. External API access requires the Custom plan, and AI tools connect through the Odoo 20 MCP server. 

Whether you need to integrate with a customer portal, eCommerce platforms like Shopify, sync data with a third-party CRM, or manage massive data streams from multiple systems, Odoo offers flexible API options to match.

What are the methods for Odoo API integration?

Odoo supports three key technologies for integration:

  1. RPC (Remote Procedure Call): Native API for direct function access
  2. REST API: A standard web-friendly interface for common use cases
  3. Queued Middleware: A message-based approach for asynchronous, scalable data exchange

Each approach has specific strengths and trade-offs, depending on the systems involved, the nature of the data flow, and the real-time needs of your application. 

These methods can also be combined, e.g. REST for public APIs and RPC for internal jobs. For AI assistants such as Claude or ChatGPT, Odoo 20 adds a further route: a native MCP server.

What is the Odoo external API (JSON-2 and RPC)?

Odoo natively supports an RPC (Remote Procedure Call) interface that enables direct method calls using either JSON or XML. 

Since Odoo 19, the standard is the JSON-2 API: you POST a JSON body with an API key as a bearer token, for example to call Odoo's search_read method at /json/2/res.partner/search_read. The older XML-RPC and JSON-RPC endpoints (/xmlrpc, /xmlrpc/2, /jsonrpc) are deprecated and scheduled for removal in Odoo 22 (fall 2028) and Odoo Online 21.1 (winter 2027). 

The RPC API approach allows deep access into Odoo’s core functionalities and is the most tightly integrated method in the platform.

Advantages:

  • Perfect for fast interactions with minimal overhead, as it’s lightweight and efficient.
  • Supports all internal Odoo methods without extra configuration, allowing full system access.

Disadvantages:

  • Operates at the function level rather than with structured resources, meaning that you’re calling backend methods like create, write, or search_read directly, rather than working with standard REST resources like /products or /customers
  • It’s not as widely adopted and lacks the universal standardisation of REST or GraphQL.
  • Each JSON-2 call runs in its own database transaction, so several calls can't be chained into one atomic operation.

Best for: Internal integrations, performance-critical tasks, or when full method access is needed without constraints. 

Does Odoo have a REST API?

The RESTful API in Odoo follows conventional web standards, enabling interaction with Odoo data using common HTTP methods like GET, POST, PUT, and DELETE. 

It's a widely supported interface and ideal for integrating with external platforms or services.

While Odoo doesn’t include a native REST API by default, many implementations use community modules or custom-built controllers to expose RESTful endpoints.

Advantages:

  • Standardised, widely adopted and supported by nearly every modern programming language.
  • Organises data into clear types (like products or orders), making your system easier to manage and scale later on.
  • REST client libraries are available in most frameworks, as it’s a widely supported ecosystem.
  • Easier to document and test REST APIs, using tools like Postman or Swagger.

Disadvantages:

  • REST calls come with additional metadata that can slow things down.
  • Less efficient for complex use cases, and performance may suffer if many chained API calls are needed.
  • HTTP-only and offers no built-in support for alternative transports like WebSockets.
  • Statelessness is a common REST constraint, which can sometimes lead to repetitive calls, e.g. refetching auth/user data.

Best for: Web portals, mobile apps, and third-party service integrations where universal compatibility is key.

When should you use queued middleware with Odoo?

For projects with high volumes of data or asynchronous communication needs, Odoo can be integrated using queued middleware tools like Kafka or RabbitMQ, although it does not include native support for these tools.

This pattern decouples systems and ensures fault-tolerant communication even when one side is temporarily unavailable.

Advantages:

  • Allows communication without depending on response times.
  • Handles large datasets and allows for messages to be buffered and processed when resources are available.
  • Highly scalable and resilient, meaning that messages won’t be lost even during system outages.

Disadvantages:

  • More complex setup and requires a separate queueing infrastructure.
  • Not real-time: delays are possible as processing happens asynchronously.
  • Requires careful setup and ongoing management of message brokers due to middleware dependencies

Best for: Data-heavy processes like reporting, syncing across systems, or bulk read/write operations over time.

How do you choose the right Odoo API integration method?  

When selecting the right API strategy for your Odoo project, consider:

  • Integration partner: Are you working with a third-party system or internal tools?
  • Real-time needs: Do you need instant data transfer or is delayed processing acceptable?
  • Volume of data: Are you syncing a handful of records or streaming thousands per hour?
  • System complexity: Do you want something standardised and plug-and-play or highly optimised and custom?

Here’s a quick rule of thumb:

Use case

Best method

Fast internal system calls

RPC

Common integrations (e.g. Zapier)

REST API

Asynchronous big-data operations

Queued Middleware

When choosing an API connection method in Odoo, you don’t have to strictly restrict yourself to one.

Often, a hybrid approach is used, e.g. REST for public-facing systems, RPC for backend orchestration, and queues for heavy background processing.

Please note: Odoo's external API is only available on the Custom pricing plan, not on One App Free or Standard. REST and middleware options depend on your Odoo version or custom implementations.

What should you check before launching an Odoo API integration?

Before jumping into development, clarify these points with your team or integration partner:

  • Authentication strategy: Will you use tokens, session-based auth, or OAuth?
  • Error handling and retries: Especially important for queued or batch operations
  • Data ownership and mapping: Who owns the source of truth for each field?
  • Security considerations: Make sure endpoints are protected and data is encrypted
  • Monitoring and logging: Have visibility into your API traffic and failure rates

A well-prepared integration saves time, reduces bugs, and ensures your connected systems stay reliable and future-proof.


Odoo API FAQs

What methods does Odoo use for API integration? 

Odoo integrates through its external API (JSON-2 since Odoo 19; XML-RPC and JSON-RPC are deprecated), REST endpoints added with custom or community modules, and queued middleware such as RabbitMQ or Kafka for high data volumes. AI assistants connect through the Odoo 20 MCP server.

Is it easy to connect Odoo to other software via API? 

Yes, if your plan includes it. Odoo's external API is only available on the Custom pricing plan, not on One App Free or Standard. With it, you can link Odoo to tools like Shopify or third-party CRMs to automate workflows and sync data without manual entry.

How do I keep my Odoo API connection secure? 

Use a dedicated Odoo API key per integration, sent as a bearer token in the Authorization header, never a user's password. Run integrations as a bot user with only the access rights they need, encrypt all traffic with HTTPS, and revoke a key instantly if a security risk is detected.

Is XML-RPC deprecated in Odoo?

Yes. XML-RPC and JSON-RPC (/xmlrpc, /xmlrpc/2, /jsonrpc) are deprecated since Odoo 19. Odoo's documentation schedules their removal in Odoo 22 (fall 2028) and Odoo Online 21.1 (winter 2027). Move integrations to the JSON-2 API before then, ideally as part of your Odoo upgrade.

What is the Odoo JSON-2 API?

JSON-2 is Odoo's external API since Odoo 19. You POST a JSON body to /json/2/model/method, for example /json/2/res.partner/search_read, with an API key as a bearer token in the Authorization header. Each call runs in its own database transaction, so several calls can't be chained atomically.

Which Odoo plan do I need for API access?

You need the Custom plan. Odoo's documentation states that access to data via the external API is only available on Custom pricing plans, not on One App Free or Standard. If you are on Standard and plan integrations, budget for the switch to Custom before development starts.

How do AI tools like Claude or ChatGPT connect to Odoo?

Through MCP (Model Context Protocol). Odoo 20 ships a native MCP server at a /mcp endpoint with five read-only tools by default; an administrator must enable write actions. It uses dedicated MCP API keys and enforces the user's access rights. Learn more about the Odoo MCP server.


Need to integrate Odoo with other systems? Talk to us!

Choosing the right Odoo API method is key when you’re looking to sync data with your CRM, powering real-time dashboards, or managing large-scale data flows.

Talk to our experts to explore what’s possible with Odoo’s integration capabilities and get clarity on the best-fit approach for your use case.

in Odoo

Your Dynamic Snippet will be displayed here... This message is displayed because you did not provided both a filter and a template to use.

Read more about Odoo: 

Meet much.! Learn more about our team

About us
Talk to our experts
Breaking down methods for Odoo API integration
Yasmin 14 May 2026