onboarding.onboarding.step: fields, relations and API
The onboarding.onboarding.step model ("Onboarding Step") is a persistent model declared by the Onboarding Toolbox module, then extended by 1 other module. It exposes 21 fields, 15 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.step- Label
- Onboarding Step
- Type
- Persistent (models.Model)
- SQL table
onboarding_onboarding_step- Origin module
- Onboarding Toolbox (
onboarding) - Extended by
- account
- Default order (_order)
sequence asc, id asc- Display field (_rec_name)
title
Model fields
15 own fields, 0 inherited from mixins and 6 automatic ORM fields. Click a name to get a direct link to that field.
21 of 21 fields shown
| Technical name | Label | Type | Details |
|---|---|---|---|
| button_text | Button text Text on the panel's button to start this step | char | requiredtranslatable |
| current_progress_step_id | Step Progress Onboarding Progress Step for the current context (company). | many2one | computed |
| current_step_state | Completion State | selection | computed Values computed at runtime |
| description | Description | char | translatable |
| done_icon | Font Awesome Icon when completed | char | |
| done_text | Text to show when step is completed | char | translatable |
| is_per_company | Is per company | boolean | |
| onboarding_ids | Onboardings | many2many | |
| panel_step_open_action_name | Opening action Name of the onboarding step model action to execute when opening the step, e.g. action_open_onboarding_1_step_1 | char | |
| progress_ids | Onboarding Progress Step Records All related Onboarding Progress Step Records (across companies) | one2many | read-only inverse: |
| sequence | Sequence | integer | |
| step_image | Step Image | binary | |
| step_image_alt | Alt Text for the Step Image Show when impossible to load the image | char | translatable |
| step_image_filename | Step Image Filename | char | |
| title | Title | char | translatable |
| 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: onboarding_ids
- onboarding.progress.step: current_progress_step_id, progress_ids
Fields of other models pointing here
- onboarding.onboarding: step_ids
- onboarding.progress.step: step_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.step/search_read" \
-H "Authorization: bearer $ODOO_API_KEY" \
-H "X-Odoo-Database: your-db" \
-H "Content-Type: application/json" \
-d '{"domain":[],"fields":["title","button_text","description","done_icon","done_text"],"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.step/search_read",
headers=headers,
json={"domain": [], "fields": ["title","button_text","description","done_icon","done_text"], "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-step">onboarding.onboarding.step (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.