Odoo GraphQL API
The ultimate "Headless Odoo" solution. Securely expose your models via a high-performance GraphQL endpoint with zero code.
Enterprise Grade Features
Zero-Trust Security
Built on Odoo's native security layer. Respects all ACLs, Record Rules, and field-level permissions.
High Performance
Eliminate over-fetching. Request exactly what you need. Supports nested queries to fetch related records in a single HTTP request.
Developer Experience
Ship faster with self-documenting APIs. Includes built-in GraphiQL Explorer, strong typing, and error handling.
Interactive API Explorer
Built-in GraphiQL Console
Test your queries instantly. Our module includes the standard GraphiQL explorer, accessible directly from your Odoo instance after installation.
http://your-odoo-server/graphiql
Detailed guides available locally in:
/odoo_graphql_exposer/docs/
JSON-RPC vs GraphQL
Why modern front-end teams switch to GraphQL
| Feature | Standard JSON-RPC | Odoo GraphQL |
|---|---|---|
| Data Fetching |
Over-fetching
Downloads unused fields
|
Exact
Fetching
Get only what you ask for
|
| Nested Relations |
N+1
Problem
Requires multiple API calls
|
Single Request
Fetch relations in one go
|
| Mobile Performance |
Heavy
Payload
Slow on weak networks
|
Optimized
~60% smaller payloads
|
| Documentation |
Manual
Read Python source code
|
Self-Documenting
Introspection & Auto-docs
|
Powerful Configuration Tools
Everything you need to manage your API without writing code.
1-Click Auto-Expose Wizard
Exposing hundreds of models manually is tedious. Our wizard automates the entire process while respecting your security rules.
-
Group-Based Exposure: Select a User Group (e.g., "Portal User") and instantly expose ALL models they can access.
-
Smart ACL Inheritance: Automatically configures API permissions (Read, Write, Create, Unlink) to match Odoo's native Access Rights.
Global API Performance & Security
Manage the health and stability of your GraphQL endpoint with enterprise-grade controls directly from Settings.
-
Rate Limiting: Prevent abuse by setting global request limits (e.g., 100 requests/minute per user).
-
Recursion Protection: Define a
Maximum Query Depthto block malicious deep-nested queries that could stall your server.
Granular Model Control
Need more precision? Dive into specific model configurations to fine-tune exactly what is exposed.
-
Field Selection: Cherry-pick specific fields to expose. Hide sensitive data like
cost_pricewhile exposing public info. -
Custom Aliasing: Rename complex Odoo tech-names (e.g.,
x_studio_field_1) to clean, developer-friendly GraphQL names (e.g.,productCategory).
Technical Documentation
Beautiful, Integrated Documentation
Access comprehensive, auto-generated documentation directly within your Odoo instance.
Overview
Welcome to the Odoo GraphQL API documentation.
exposedModels query to see what's available.
1. Installation
pip install strawberry-graphql
2. Configuration
Go to Settings > Technical > GraphQL Configuration.
- Manually add models.
- Use the wizard to auto-expose models.
3. Queries
{
records(
model: "res.partner"
domain: [["is_company", "=", true]]
limit: 5
fields: ["id", "name", "email"]
)
}
4. Mutations
mutation {
createRecord(
model: "res.partner"
values: { name: "New Partner" }
)
}
Explore Our Ecosystem
Expert Odoo Development
We specialize in Security, AI, and Automation for Odoo. Get in touch for custom API integrations and support.
Contact SupportOdoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module