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.

Best for: Operations managers, ERP administrators, business owners Practical guide for business decision-makers

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'll leave with

  • How Odoo authenticates API access
  • What data the Odoo API exposes
  • Whether no-code tools cover your use case
  • What a proper Odoo API integration involves
  • When you need a developer and when you do not

How Odoo API access works

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.

What the Odoo API lets you do

The Odoo API gives you programmatic access to the core data in your account. Broadly that covers:

  • Any model in the database, including custom ones
  • Sales orders, invoices and payments
  • Products, stock moves and warehouses
  • Contacts, companies and pricelists
  • Projects, tasks and timesheets
  • Accounting entries and journals

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.

Odoo and no-code tools

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.

Building with the Odoo API

Connecting Odoo to another system means working through five things, in roughly this order:

  1. Authenticate using the credentials above, and store them somewhere your team can rotate
  2. Map the data, deciding what moves between Odoo and the other system, in which direction, and triggered by what
  3. Handle the edge cases, such as a record that already exists on one side but not the other, or a partially completed transaction
  4. Build error handling, so a failed call is retried or surfaced rather than silently dropped
  5. Set up monitoring, so you find out something stopped working before it becomes an accounting problem

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.

When to bring in a developer

Some Odoo API work is genuinely straightforward. Some is not. An honest split:

Odoo records you can work with alone

  • Reading records into a report
  • Creating a contact from an external form
  • Exporting a product list
  • Confirming which fields a model exposes

When Odoo needs a developer on the job

  • Self-hosted versus Odoo Online

    What you can install and reach differs sharply between the two, and it changes the integration design.

  • Custom modules and inherited models

    Odoo is usually customised, so the standard field list is rarely the real one.

  • Version upgrades

    Odoo makes breaking changes between major versions, and integrations need planning around that.

  • Accounting and stock at the same time

    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.

Key takeaways

  • 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 API covers any model in the database, sales orders, products and more
  • Zapier coverage is limited, so the API is usually the right route
  • Simple read-only use cases are achievable without specialist help
  • Two-way sync with accounting or payroll is a development project, not a weekend task
OdooAPI IntegrationIntegrations

Ask the author

Question about the Odoo API?

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 Kasun Wijayamanna
Founder, replies within one business day

Get Started

Want help choosing the right next step?

Tell us what you are comparing, replacing, or trying to improve. We will come back with a practical recommendation and realistic scope.

Australian owned and operated

Built here. Your data stays here.

  • No offshore development. Everything is written by our own team in Australia. Nothing is subcontracted overseas.
  • Your data stays onshore. Hosted in Australia, on infrastructure you own, under Australian law.
  • Every state, not just ours. Perth, Melbourne, Sydney, Brisbane, Adelaide and everywhere between.