| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Lines of code | 4178 |
| Technical Name |
odoo_rest_suite |
| License | LGPL-3 |
| Website | https://apps.odoo.com/apps/modules/19.0/odoo_rest_suite |
| Versions | 18.0 19.0 |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Lines of code | 4178 |
| Technical Name |
odoo_rest_suite |
| License | LGPL-3 |
| Website | https://apps.odoo.com/apps/modules/19.0/odoo_rest_suite |
| Versions | 18.0 19.0 |
🚀 Odoo Rest Suite - Basic Plan
Comprehensive REST API Management & Documentation Solution for Odoo
Rest Suite provides professional REST API management and documentation tools for Odoo. Automatically discover REST API endpoints and generate Swagger/OpenAPI documentation with interactive testing capabilities.
✨ Key Features
🔌 Generic Model API
Access ANY Odoo model via REST API endpoints automatically. No coding required!
📚 Swagger UI
Interactive documentation interface for visual API exploration and testing
🔍 Auto Discovery
Automatically discover and document your API endpoints
📥 OpenAPI Spec Download
Download OpenAPI 3.0 specifications for sharing and integration
🛠️ Endpoint Management
Create, manage, and document custom API endpoints with full CRUD support
🔐 Secure Authentication
Session-based authentication with easy session ID extraction
🚀 Quick Start
1. Set Up Permissions
- Activate Developer Mode (for version 19.0): Go to Settings → Scroll down → Click "Activate the Developer Mode"
- Go to Settings → Users & Companies → Users
- Select your user
- In Access Rights tab, check "OpenAPI Manager"
- Click Save and log out/in
2. Access Generic Model API
All Odoo models are automatically accessible via REST API:
GET /api/v1/{model_name}/{id} # Get single record
POST /api/v1/{model_name} # Create record
PUT /api/v1/{model_name}/{id} # Update record
DELETE /api/v1/{model_name}/{id} # Delete record
3. Get Your Session ID
- Go to Rest Suite → Settings → API Tools & Help tab
- Click "Extract Session ID" button
- Copy the session ID
Figure 1: API Endpoints Management Interface showing the Settings dialog with Session ID extraction and Popular Models for Testing
4. Make API Requests
-H "Cookie: session_id=YOUR_SESSION_ID"
💎 BASIC Plan Features
Auto Discovery
Automatically discover and create endpoints:
- Go to Rest Suite → OpenAPI → Discover Endpoints
- Click "Discover Endpoints" button
- Endpoints are created automatically
Swagger UI - Interactive Documentation
Access at /api/docs or via menu: Rest Suite → OpenAPI → Swagger UI
- View all endpoints in one place
- Test endpoints directly in browser
- See request/response examples
- Understand parameters automatically
Figure 2: Interactive Swagger UI showing Odoo REST API documentation with categorized endpoints (discovery, fields, records) and interactive testing capabilities
OpenAPI Spec Download
Download your API specification at /api/openapi.json
- Import into Postman/Insomnia
- Share with team members
- Generate API client code
- Version control your API
📝 Common Model Examples
| Model | Description | Example Endpoint |
|---|---|---|
res.partner |
Contacts | /api/v1/res.partner |
sale.order |
Sales Orders | /api/v1/sale.order |
account.move |
Invoices | /api/v1/account.move |
product.product |
Products | /api/v1/product.product |
✅ Use Cases
🔄 Integrations
Connect Odoo with external systems, third-party apps, and services
📱 Mobile Apps
Build mobile applications that interact with your Odoo instance
🤖 Automation
Automate business processes with API-driven workflows
📊 Reporting
Extract data for custom reporting and analytics
🎯 Perfect For
- Developers building integrations with Odoo
- Businesses needing API access to their data
- Teams requiring API documentation and testing tools
- Organizations implementing API-first strategies
For plan upgrades or support, contact us.
Odoo Rest Suite - Basic Plan - Professional REST API Management for Odoo
Compatible with Odoo 19.0+
Please log in to comment on this module