External API

Quick summary: New integrations should use the Odoo 19 JSON-2 API, a dedicated technical account, and a narrowly privileged API key.

---

Open your user preferences in Odoo

Your Odoo address

Enter the base address of your Odoo instance. It will be stored only in this browser.

Odoo base address

The documentation does not receive your address, username, or password.

Forget addressCancelSave

Before you start

• Create a dedicated user with the minimum required access.
• Generate an API key on that user’s profile and store it in a secrets manager.
• Use a test environment and do not use the integration account for interactive work.

Send requests to /json/2/<model>/<method> with Authorization: bearer <api-key>. Provide the database in the X-Odoo-Database header when required by the environment. Requests and responses use JSON.

Find technical names

Enable developer mode from the command palette (Ctrl+K, then debug). On a form, open the bug menu and inspect its fields. This view provides the technical model and field names required by the integration.

Danger

Never place an API key in source code, documentation, screenshots, or browser-side JavaScript. Every API request is subject to the same access rules as the authenticated user.

Technical reference: Odoo 19 External JSON-2 API. The legacy XML-RPC and JSON-RPC endpoints are deprecated and should not be used for new integrations.