Technical Specifications & Compatibility
Technical Module Name
Supported Odoo Versions
v18.0v19.0
License
Aura
Deployment Support
Odoo OnlineOdoo.shOn Premise
Lines of Code
3129 lines (Python / XML / JS)
Overview & Description
Aura Odoo TechSupports:Odoo 20Community API Builder Studio20.0.1.0.0: endpoints, tokens, Swagger docs and a request log, all from the Odoo UIPublish a REST API from any Odoo model. No code.Pick a model, tick the fields you want to expose, add a domain filter and switch on the HTTP methods. The endpoint is live at /api/v1/custom/<slug> straight away, with token authentication, rate limits, Swagger documentation and a log of the calls.✓Any non-transient model: GET, POST, PUT and DELETE, each switched on per endpoint✓Bearer token, X-API-Key header or ?token=, with scopes, expiry and rate limits✓OpenAPI 3 spec and Swagger UI generated from your endpoint settings 4HTTP methods, switched on per endpoint3Ways to send a token6Built-in login and token routes90Days of request log kept why teams use itEverything an integration asks forA mobile app, a partner portal or a data sync needs a stable URL, a key and some limits. Configure them here instead of writing a controller.BuildFrom a model to a live URL in a few clicks.Any Odoo modelChoose the model and the route slug. The URL appears on the form with a copy button. Slugs are lowercase words joined by hyphens.You choose the fieldsLoad Fields from Model lists the model's stored fields. Switch each one on for responses, create, update, required, searchable and sortable.Relations, nestedMany2one, One2many and Many2many fields come back as id and name, or as nested objects with the sub-fields and depth you name.A fixed filter per endpointA domain such as [('state','=','sale')] limits what the endpoint can read, change or delete.ProtectTokens, scopes and limits you can see.Bearer, API key or query tokenAuthorization: Bearer, the X-API-Key header, or ?token=. Login, API key and bearer token types.Scopes and expiryLimit a token to chosen endpoints, give it an expiry date, revoke it, or regenerate its value.Rate limits and IP listsRequests per minute and per hour on the token and on the endpoint, the lower one wins. IP whitelist on either, on the address Odoo sees.Runs as the token's userRecords are read and written with the access rights and record rules of the user the token belongs to. A call that user may not make answers 403.OperateDocumentation and a record of the calls.Swagger that writes itselfOpenAPI 3.0.3 at /api/studio/spec and Swagger UI at /api/studio/docs, rebuilt from the endpoints you configured.Request logMethod, status, time, IP, user agent, token and payload, with list, pivot and graph views. A daily job deletes entries older than 90 days.DashboardTotals, success rate, average time, a 30-day traffic chart, method split and the top endpoints, tokens and IP addresses.Multi-company awareEndpoints and tokens carry a company. A token from another company is refused, and models with a company field return that company's rows and the rows that belong to no company. overviewSee what you have publishedEvery screen on this page is a real Odoo 20 Community screen with the module installed. The names, e-mail addresses and amounts are made-up sample data, and the traffic comes from a test script.The dashboard. Totals and success rate, endpoint and token counts, requests per day for the last 30 days, the split by method and the busiest endpoints. The numbers come from a test run with sample traffic.One row per endpoint. The slug, the model, the methods that are switched on, whether a token is required and how many requests it has served. Archive an endpoint to switch it off. build an endpointModel, fields, filter, securityOpen API Studio, Endpoints, New. The form has a tab for each decision.Pick the fields. Customers on the Contact model: GET, POST and PUT are on, DELETE is off. Name is required on create. Name, e-mail and city can be searched and sorted. A field that is not switched on never appears in a response.Nested records. The order lines field is set to depth 2 with the sub-fields product_id, product_uom_qty and price_subtotal, so each order comes back with its lines. Without sub-fields a relation returns only id and name.A fixed filter. Only confirmed orders can be read through this endpoint, and the same filter applies when a record is read, updated or deleted by id.Security on the endpoint. Authentication, the tokens allowed in, the endpoint's own rate limits and IP whitelist, and an optional list of the fields POST and PUT may write. tokensWho may call what, and how oftenCreate a token per app or partner, so one can be revoked without touching the others.Tokens. Label, type, the user it runs as, status, limits, how often it was used and when it expires. Revoked tokens drop out of the Active filter.Self-registration stays off. Settings, API Studio. The registration route answers 403 until an administrator switches this on.Scope and restrictions. Endpoint Access, Rate Limiting and Restrictions tabs. The Partner Integration key can only call sales-orders, only from the addresses listed, and expires on a date you choose. Regenerate Token makes a new value and the old one stops working. the apiWhat a call looks likeThese are real requests and answers from the test database used for the screenshots, with the host and tokens replaced.Search a list, with a page sizecurl -H "Authorization: Bearer YOUR_TOKEN" \ "https://your-odoo.com/api/v1/custom/customers?search=cafe&limit=5" {"success": true, "count": 1, "total": 1, "page": 1, "limit": 5, "pages": 1, "data": [{"id": 10, "name": "Bluebird Cafe", "email": "bluebird.cafe@example.com", "city": "Austin", "country_id": {"id": 233, "name": "United States"}}]}A nested response, sorted by amountcurl -H "X-API-Key: YOUR_KEY" \ "https://your-odoo.com/api/v1/custom/sales-orders?limit=1&sort=amount_total&order=desc" {"success": true, "count": 1, "total": 6, "page": 1, "limit": 1, "pages": 6, "data": [{"id": 5, "name": "S00005", "partner_id": {"id": 13, "name": "Summit Outfitters"}, "amount_total": 1661.75, "state": "sale", "date_order": "2026-10-02T15:55:13", "order_line": [{"product_id": {"id": 4, "name": "Ergo Chair"}, "product_uom_qty": 5.0, "price_subtotal": 1445.0}]}]}A refused writecurl -X POST -H "Authorization: Bearer YOUR_TOKEN" -H "Content-Type: application/json" \ -d '{"city": "Boise"}' https://your-odoo.com/api/v1/custom/customers {"error": true, "message": "Missing required field: name", "status": 400, "code": "VALIDATION_ERROR"}A token outside its scopecurl -H "Authorization: Bearer MOBILE_APP_TOKEN" https://your-odoo.com/api/v1/custom/sales-orders {"error": true, "message": "Token does not have access to this endpoint.", "status": 403, "code": "SCOPE_DENIED"}errorsEvery refusal has a codeErrors share one shape: error, message, status and code.StatusCodeWhen401AUTH_REQUIREDNo token was sent to an endpoint that requires one.401INVALID_TOKENThe token is unknown, revoked or expired.403SCOPE_DENIEDThe token is not allowed on this endpoint.403ACCESS_DENIEDThe token's user may not read or change that model or record.403IP_DENIEDThe caller's IP is not on the token's or the endpoint's whitelist.405METHOD_NOT_ALLOWEDThat HTTP method is switched off on this endpoint.404NOT_FOUNDUnknown endpoint slug, or no record with that id inside the endpoint's filter.400VALIDATION_ERRORA required field is missing from a POST body, or a value cannot be converted.429RATE_LIMIT_MINUTEThe per-minute limit was reached. RATE_LIMIT_HOUR for the hourly limit. query parametersWhat a list request understandspage, limitPage number, and records per page. limit is capped at the endpoint's maximum page size. Defaults are set per endpoint, 20 and 100 to start.searchCase-insensitive match on any field you marked searchable.sort, orderSort by a field you marked sortable, asc or desc. Other fields are ignored.field=valueExact match on any exposed integer, float, boolean, many2one (by id) or text field, for example ?city=Austin.Single recordGET /api/v1/custom/<slug>/<id> returns one record, inside the endpoint's filter.WritePOST creates and PUT /<id> updates, from a JSON body. Only fields switched on for create or update are accepted, and others are skipped without an error. documentation and logsShow it, then audit itHand the Swagger page to the developer on the other side, and read the log when something fails.Documentation that follows your settings. Each endpoint is listed with the parameters it takes and an example response built from the fields you exposed. Use Authorize to paste a token and Try it out to call it. The Swagger page loads its viewer from unpkg.com, so the browser needs internet access.The calls, in a list. Failed calls are red. Filter on Success or Failed, build a pivot of days by endpoint, or open the line graph.And in detail. Endpoint, status and time, the caller's IP and user agent, the token used and the request body. how it worksFrom model to live API1Create the endpointAPI Studio, Endpoints, New. Choose the model, check the slug and the methods, then press Load Fields from Model.2Choose the fieldsSwitch on what responses, create and update may use. Add a domain filter and set depth for relations.3Create a tokenSecurity, API Tokens, New. Pick the user, the endpoints, the limits and an expiry. Copy the value from the form.4Call it, then watchSend the request, try it from Swagger, and follow the traffic in the dashboard and the request log. routesWhat the module adds to your serverRouteWhat it doesEndpoint/api/v1/custom/<slug>Dynamic list, read, create, update and delete for every active endpoint.LoginPOST /api/studio/auth/loginOdoo login and password in, a bearer token out (valid 24 hours). Accounts with two-factor authentication are refused: give them an API key.Current userGET /api/studio/auth/meThe user and token behind the token you send.RefreshPOST /api/studio/auth/refreshExchanges a valid token for a new one.LogoutPOST /api/studio/auth/logoutRevokes the token you send.My tokensGET /api/studio/auth/tokensLists the caller's tokens.Named tokenPOST /api/studio/auth/tokenCreates a named token. Internal users only.Docs/api/studio/docs and /api/studio/specSwagger UI and the OpenAPI 3.0.3 JSON. configurationThe settings behind an endpointName and slugThe slug is lowercase words with hyphens, for example sales-orders. Slugs are unique. The full URL is shown on the form.Odoo modelAny model that is not transient.MethodsAllow GET, POST, PUT and DELETE separately. A method that is off answers 405.Domain filterA Python list such as [('state','=','sale')]. Only the usual comparison operators are accepted.Require authenticationOn by default. Off makes the endpoint public.Allowed tokensThe same link as a token's Allowed Endpoints. When it is filled in, only those tokens may call the endpoint.Rate limitsPer minute and per hour, 60 and 1000 to start. The token has its own, and the lower one applies.IP whitelistComma-separated, on the endpoint and on the token.Writable fieldsOptional comma-separated list that restricts POST and PUT further.PaginationDefault page size 20, maximum 100.Token typesBearer, API key and login. The type is a label: all three are sent the same way.CompanyEndpoints and tokens carry a company. A mismatch answers 403. good to knowStraight answersWhose access rights apply to a call?The token's user. Records are read and written as that user, so their access rights and record rules apply and a call they may not make answers 403 ACCESS_DENIED. The one exception is an endpoint with Require Authentication switched off: nobody is signed in, so its field list and domain are the whole permission.Who can see the tokens?Only administrators. The API Studio menus and models are limited to the Administration: Settings group. A token's value is shown on its form and is also kept in the database next to its hash, so treat access to the database as access to the tokens.Can anyone create an account through the API?Not unless you allow it. POST /api/studio/auth/register answers 403 until an administrator ticks Allow Self-Registration in Settings, API Studio. When it is on, any caller who can reach your server can create a portal user and receive a token that works on every endpoint.How do rate limits count?In memory, per server process, in fixed one-minute and one-hour windows. With several workers each one counts separately, and a restart resets the counts.How does the IP whitelist find the caller's address?It uses the address Odoo sees for the connection and ignores any X-Forwarded-For header a caller sends. Behind a reverse proxy, start Odoo with proxy_mode switched on, so that Odoo itself reads the real client address from the proxy.Which company's records does a list return?On models with a company field, a list returns the endpoint's company and the records that belong to no company. Reading one record by id leaves company rules to the user's own record rules.Does it need Odoo Enterprise?No. It depends on Base and Web only, and every screenshot here was taken on Odoo 20 Community.How long are the logs kept?90 days. A daily scheduled action deletes older entries. Request bodies of POST and PUT calls are stored with the entry. supportWe are here to helpWritten and maintained by Aura Odoo Tech.EmailQuestions, problems or a setting you need: write to us directly.odooaura@gmail.comWebsiteMore Odoo modules, documentation and customisation services.www.auraodoo.tech
Key Capabilities & Features
- The author can leave a single reply to each comment.
- This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
- If you want to start a discussion with the author or have a question related to your purchase, please use the support page.
Screenshots & Previews
14 images availableExpand Preview
Expand Preview

Expand Preview

Expand Preview

Expand Preview

Expand Preview

Expand Preview

Expand Preview

Expand Preview

Expand Preview

Expand Preview

Expand Preview

Expand Preview

Expand Preview
The AuraOdoo Quality Guarantee
100% Tested
Verified with Odoo 17, 18, and 19 test pipelines for stability and no conflicts.
Clean Architecture
Built according to official Odoo guidelines and PEP 8 standards with zero bloat.
Dedicated Support
Free installation assistance and quick bug turnaround from our team.