onboarding.onboarding: fields, relations and API
The onboarding.onboarding model ("Onboarding") is a persistent model declared by the Onboarding Toolbox module, then extended by 1 other module. It exposes 17 fields, 11 of them declared directly on the model; 2 fields from other models point to it. Below you will find every field with its technical name, type, label and relations, followed by an Odoo 19 JSON-2 API call.
Model identity
- Technical name
onboarding.onboarding- Label
- Onboarding
- Type
- Persistent (models.Model)
- SQL table
onboarding_onboarding- Origin module
- Onboarding Toolbox (
onboarding) - Extended by
- account
- Default order (_order)
sequence asc, id desc
Model fields
11 own fields, 0 inherited from mixins and 6 automatic ORM fields. Click a name to get a direct link to that field.
17 of 17 fields shown
| Technical name | Label | Type | Details |
|---|---|---|---|
| current_onboarding_state | Completion State | selection | read-onlycomputed Values: |
| current_progress_id | Onboarding Progress Onboarding Progress for the current context (company). | many2one | computed |
| is_onboarding_closed | Was panel closed? | boolean | computed |
| is_per_company | Should be done per company? | boolean | read-onlycomputed |
| name | Name of the onboarding | char | translatable |
| panel_close_action_name | Closing action Name of the onboarding model action to execute when closing the panel. | char | |
| progress_ids | Onboarding Progress Records All Onboarding Progress Records (across companies). | one2many | read-only inverse: |
| route_name | One word name | char | required |
| sequence | Sequence | integer | |
| step_ids | Onboarding steps | many2many | |
| text_completed | Message at completion Text shown on onboarding when completed | char | |
| create_date | Created on | datetime | read-onlyautomatic |
| create_uid | Created by | many2one | read-onlyautomatic |
| display_name | Display Name | char | read-onlycomputedautomatic |
| id | ID | integer | read-onlyautomatic |
| write_date | Last Updated on | datetime | read-onlyautomatic |
| write_uid | Last Updated by | many2one | read-onlyautomatic |
Relations
Models linked from this model
- onboarding.onboarding.step: step_ids
- onboarding.progress: current_progress_id, progress_ids
Fields of other models pointing here
- onboarding.onboarding.step: onboarding_ids
- onboarding.progress: onboarding_id
Reading this model through the API
Odoo 19 JSON-2 API call reading the first five records with real fields of the model. Replace the instance, database and API key with your own.
curl -X POST "https://your-instance.odoo.com/json/2/onboarding.onboarding/search_read" \
-H "Authorization: bearer $ODOO_API_KEY" \
-H "X-Odoo-Database: your-db" \
-H "Content-Type: application/json" \
-d '{"domain":[],"fields":["name","route_name","panel_close_action_name","sequence","text_completed"],"limit":5}'import requests
BASE_URL = "https://your-instance.odoo.com/json/2"
headers = {"Authorization": f"bearer {API_KEY}", "X-Odoo-Database": "your-db"}
res = requests.post(
f"{BASE_URL}/onboarding.onboarding/search_read",
headers=headers,
json={"domain": [], "fields": ["name","route_name","panel_close_action_name","sequence","text_completed"], "limit": 5},
)
res.raise_for_status()
print(res.json())- External API access requires Odoo's Custom plan.
- XML-RPC and JSON-RPC will be removed in Odoo 22 (fall 2028): use JSON-2.
- The access rights and record rules of the key's user apply.
Cite this tool
Writing a tutorial, internal documentation or a forum answer? Copy this link to send your readers to the up-to-date reference.
<a href="https://aidoo.ai/en/outils/explorateur-modeles-odoo/onboarding-onboarding">onboarding.onboarding (Odoo 19.0)</a>Sources
Data verified on September 23, 2026 · Odoo 19.0 Community
Have an Odoo project, or want to put your ERP to work with AI? Let's talk
Implementation, custom module development, connecting Claude or ChatGPT to your data: tell us about your context and we will reply within 24 business hours.