How to Get Your Odoo API Key (and What to Build With It)
How Odoo API access works, what the Odoo API lets you connect, and when you need a developer to do it properly. Perth, Melbourne, Sydney and Brisbane.
How Odoo API access works, what the Odoo API lets you connect, and when you need a developer to do it properly. Perth, Melbourne, Sydney and Brisbane.
Who this is for
Operations managers, ERP administrators, business owners who want to connect Odoo to other systems and need to understand how its API works before committing to anything.
Question this answers
How do I get Odoo API access and what can I actually connect Odoo to?
What you will leave with
Odoo uses an API key generated against your user account, used in place of a password with the XML-RPC or JSON-RPC endpoints. The exact screens move around as Odoo updates its interface, so rather than repeat a menu path that may already be out of date, the reliable source is the official documentation: Odoo external API documentation.
Odoo API access runs as a specific user, so it inherits that user's access rights and record rules. An integration that cannot see a record is usually hitting a permission rule rather than a bug.
Treat API credentials like a password. Anyone holding them can read and often write data in your Odoo account. Do not paste them into untrusted tools, and do not send them over email or chat.
The Odoo API gives you programmatic access to the core data in your account. Broadly that covers:
With that access you can push data into accounting or reporting systems, keep records in step across tools, and build dashboards from live Odoo data rather than from exports someone has to remember to run.
Zapier support for Odoo is limited. Zapier coverage is limited relative to what the API exposes, and Odoo has its own automation layer. That is why searches for connecting Odoo through no-code tools tend to turn up workarounds rather than a clean answer.
Connecting Odoo to another system means working through five things, in roughly this order:
A common pairing is Odoo with Xero or Shopify. Read-only reporting is usually straightforward. Live two-way sync is where the mapping and error handling turn it into a proper development project.
Some Odoo API work is genuinely straightforward. Some is not. An honest split:
What you can install and reach differs sharply between the two, and it changes the integration design.
Odoo is usually customised, so the standard field list is rarely the real one.
Odoo makes breaking changes between major versions, and integrations need planning around that.
Odoo posts accounting entries from stock moves, so a naive stock integration can create ledger entries you did not expect.
These integrations look simple from the outside. The work is in the detail: field mapping, conflict resolution, error recovery, and keeping everything in step as both Odoo and the connected system change over time.
If the integration touches invoicing, stock or payroll, getting it wrong has real financial consequences. A properly built integration with monitoring and alerting is worth the upfront cost.
An Odoo application programming interface (API) key is generated against a user account and used in place of that user's password with the XML-RPC or JSON-RPC endpoints. Odoo screens change as the interface is updated, so the official Odoo external API documentation is the reliable source for current steps. Treat the key like a password and never send it over email or chat.
An Odoo integration that cannot see a record is usually hitting a permission rule rather than a bug. Odoo application programming interface (API) access runs as a specific user, so the integration inherits that user's access rights and record rules. Check those rights and rules for the user behind the key before assuming the integration code is at fault.
The Odoo application programming interface (API) can reach any model in the database, including custom ones. That covers sales orders, invoices and payments, products, stock moves and warehouses, contacts, companies and pricelists, projects, tasks and timesheets, and accounting entries and journals. Because Odoo is usually customised with custom modules and inherited models, the standard field list is rarely the real one.
An Odoo integration needs a developer for live two-way sync, where data mapping and error handling turn it into a proper development project. Other signs are a self-hosted system rather than Odoo Online, which changes what can be installed and reached, custom modules and inherited models, breaking changes between major Odoo versions, and work that touches accounting and stock together, because Odoo posts accounting entries from stock moves.
Zapier support for Odoo is limited compared with what the Odoo application programming interface (API) exposes, and Odoo has its own automation layer. That is why searches for no-code Odoo connections tend to turn up workarounds rather than a clean answer. No-code chains work most of the time, but when one breaks there is rarely a way to see what failed or replay the missed records.
Ask the author
Ask it here and it comes straight to Kasun, who wrote this. No sales call, no obligation, and a real answer even if the answer is that you do not need us.
Kasun Wijayamanna
Founder, replies within one business day
Tell us what you are comparing, replacing, or trying to improve. We will come back with a practical recommendation and realistic scope.
Built here. Your data stays here.
Thanks for reaching out. We will get back to you within one business day.
See what else we do