Odoo 19.0 Community · Persistent

survey.survey: fields, relations and API

The survey.survey model ("Survey") is a persistent model declared by the Surveys module, then extended by 4 other modules. It exposes 96 fields, 66 of them declared directly on the model; 10 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.

View source code Search another model

Model identity

Technical name: survey.survey
Label: Survey
Type: Persistent (models.Model)
SQL table: survey_survey
Origin module: Surveys (survey)
Extended by: hr_recruitment_survey, hr_skills_survey, survey_crm, website_slides_survey
Default order (_order): create_date DESC
Display field (_rec_name): title
Inherits from (mixins): mail.thread mail.activity.mixin

Model fields

66 own fields, 24 inherited from mixins and 6 automatic ORM fields. Click a name to get a direct link to that field.

Hide inherited fields

96 of 96 fields shown

Technical name	Label	Type	Details
access_mode	Access Mode	`selection`	required Values: `public` (Anyone with the link), `token` (Invited people only)
access_token	Access Token	`char`
active	Active	`boolean`
allowed_survey_types	Allowed survey types	`json`	computed
answer_count	Registered	`integer`	computed
answer_done_count	Attempts	`integer`	computed
answer_duration_avg	Average Duration Average duration of the survey (in hours)	`float`	computed
answer_score_avg	Avg Score (%)	`float`	computed
attempts_limit	Number of attempts	`integer`
background_image	Background Image	`image`
background_image_url	Background Url	`char`	computed
certification	Is a Certification	`boolean`	computed, stored
certification_badge_id	Certification Badge	`many2one` → gamification.badge
certification_badge_id_dummy	Certification Badge	`many2one` → gamification.badge	related: `certification_badge_id`
certification_give_badge	Give Badge	`boolean`	computed, stored
certification_mail_template_id	Certified Email Template Automated email sent to the user when they succeed the certification, containing their certification document.	`many2one` → mail.template
certification_report_layout	Certification template	`selection`	Values: `modern_purple` (Modern Purple), `modern_blue` (Modern Blue), `modern_gold` (Modern Gold), `classic_purple` (Classic Purple), `classic_blue` (Classic Blue), `classic_gold` (Classic Gold)
certification_validity_months	Validity Specify the number of months the certification is valid after being awarded. Enter 0 for certifications that never expire.	`integer`	added by Skills Certification (`hr_skills_survey`)
color	Color Index	`integer`
description	Description The description will be displayed on the home page of the survey. You can use this to give the purpose and guidelines to your candidates before they start it.	`html`	translatable
description_done	End Message This message will be displayed when survey is completed	`html`	translatable
generate_lead	Lead Generating	`boolean`	computed added by Survey CRM (`survey_crm`)
has_conditional_questions	Contains conditional questions	`boolean`	computed
hr_job_ids	Job Position	`one2many` → hr.job	inverse: `survey_id` added by Hr Recruitment Interview Forms (`hr_recruitment_survey`)
is_attempts_limited	Limited number of attempts Check this option if you want to limit the number of attempts per user	`boolean`	computed, stored
is_time_limited	The survey is limited in time	`boolean`
lang_ids	Languages Leave the field empty to support all installed languages.	`many2many` → res.lang
lead_count	Leads Number of leads created by this survey	`integer`	computed added by Survey CRM (`survey_crm`)
lead_ids	Lead	`one2many` → crm.lead	inverse: `origin_survey_id` added by Survey CRM (`survey_crm`)
page_ids	Pages	`one2many` → survey.question	computed
progression_mode	Display Progress as If Number is selected, it will display the number of questions answered on the total number of question to answer.	`selection`	Values: `percent` (Percentage left), `number` (Number)
question_and_page_ids	Sections and Questions	`one2many` → survey.question	inverse: `survey_id`
question_count	# Questions	`integer`	computed
question_ids	Questions	`one2many` → survey.question	computed
questions_layout	Pagination	`selection`	required Values: `page_per_question` (One page per question), `page_per_section` (One page per section), `one_page` (One page with all the questions)
questions_selection	Question Selection If randomized is selected, you can configure the number of random questions by section. This mode is ignored in live session.	`selection`	required Values: `all` (All questions), `random` (Randomized per Section)
restrict_user_ids	Restricted to	`many2many` → res.users
scoring_max_obtainable	Maximum obtainable score	`float`	computed
scoring_success_min	Required Score (%)	`float`
scoring_type	Scoring	`selection`	requiredcomputed, stored Values: `no_scoring` (No scoring), `scoring_with_answers_after_page` (Scoring with answers after each page), `scoring_with_answers` (Scoring with answers at the end), `scoring_without_answers` (Scoring without answers)
session_answer_count	Answers Count	`integer`	computed
session_available	Live session available	`boolean`	computed
session_code	Session Code This code will be used by your attendees to reach your session. Feel free to customize it however you like!	`char`	computed, stored
session_link	Session Link	`char`	computed
session_question_answer_count	Question Answers Count	`integer`	computed
session_question_id	Current Question The current question of the survey session.	`many2one` → survey.question
session_question_start_time	Current Question Start Time The time at which the current question has started, used to handle the timer for attendees.	`datetime`
session_show_leaderboard	Show Session Leaderboard Whether or not we want to show the attendees leaderboard for this survey.	`boolean`	computed
session_speed_rating	Reward quick answers Attendees get more points if they answer quickly	`boolean`
session_speed_rating_time_limit	Time limit (seconds) Default time given to receive additional points for right answers	`integer`
session_start_time	Current Session Start Time	`datetime`
session_state	Session State	`selection`	Values: `ready` (Ready), `in_progress` (In Progress)
slide_channel_count	Courses Count	`integer`	computed added by Course Certifications (`website_slides_survey`)
slide_channel_ids	Certification Courses The courses this survey is linked to through the e-learning application	`one2many` → slide.channel	computed added by Course Certifications (`website_slides_survey`)
slide_ids	Certification Slides The slides this survey is linked to through the e-learning application	`one2many` → slide.slide	inverse: `survey_id` added by Course Certifications (`website_slides_survey`)
success_count	Success	`integer`	computed
success_ratio	Success Ratio (%)	`integer`	computed
survey_type	Survey Type	`selection`	required Values: `survey` (Survey), `live_session` (Live session), `assessment` (Assessment), `custom` (Custom)
team_id	Assign Leads to	`many2one` → crm.team	added by Survey CRM (`survey_crm`)
time_limit	Time limit (minutes)	`float`
title	Survey Title	`char`	requiredtranslatable
user_id	Responsible	`many2one` → res.users
user_input_ids	User responses	`one2many` → survey.user_input	read-only inverse: `survey_id`
users_can_go_back	Users can go back If checked, users can go back to previous pages.	`boolean`
users_can_signup	Users can signup	`boolean`	computed
users_login_required	Require Login If checked, users have to login before answering even with a valid token.	`boolean`
activity_calendar_event_id	Next Activity Calendar Event	`many2one` → calendar.event	computed inherited from mail.activity.mixin
activity_date_deadline	Next Activity Deadline	`date`	read-onlycomputed inherited from mail.activity.mixin
activity_exception_decoration	Activity Exception Decoration Type of the exception activity on record.	`selection`	computed Values: `warning` (Alert), `danger` (Error) inherited from mail.activity.mixin
activity_exception_icon	Icon Icon to indicate an exception activity.	`char`	computed inherited from mail.activity.mixin
activity_ids	Activities	`one2many` → mail.activity	inverse: `res_id` inherited from mail.activity.mixin
activity_state	Activity State Status based on activities Overdue: Due date is already passed Today: Activity date is today Planned: Future activities.	`selection`	computed Values: `overdue` (Overdue), `today` (Today), `planned` (Planned) inherited from mail.activity.mixin
activity_summary	Next Activity Summary	`char`	related: `activity_ids.summary` inherited from mail.activity.mixin
activity_type_icon	Activity Type Icon	`char`	related: `activity_ids.icon` inherited from mail.activity.mixin
activity_type_id	Next Activity Type	`many2one` → mail.activity.type	related: `activity_ids.activity_type_id` inherited from mail.activity.mixin
activity_user_id	Responsible User	`many2one` → res.users	read-onlycomputed inherited from mail.activity.mixin
has_message	Has Message	`boolean`	computed inherited from mail.thread
message_attachment_count	Attachment Count	`integer`	computed inherited from mail.thread
message_follower_ids	Followers	`one2many` → mail.followers	inverse: `res_id` inherited from mail.thread
message_has_error	Message Delivery error If checked, some messages have a delivery error.	`boolean`	computed inherited from mail.thread
message_has_error_counter	Number of errors Number of messages with delivery error	`integer`	computed inherited from mail.thread
message_has_sms_error	SMS Delivery error If checked, some messages have a delivery error.	`boolean`	computed inherited from mail.thread
message_ids	Messages	`one2many` → mail.message	inverse: `res_id` inherited from mail.thread
message_is_follower	Is Follower	`boolean`	computed inherited from mail.thread
message_needaction	Action Needed If checked, new messages require your attention.	`boolean`	computed inherited from mail.thread
message_needaction_counter	Number of Actions Number of messages requiring action	`integer`	computed inherited from mail.thread
message_partner_ids	Followers (Partners)	`many2many` → res.partner	computed inherited from mail.thread
my_activity_date_deadline	My Activity Deadline	`date`	read-onlycomputed inherited from mail.activity.mixin
rating_ids	Ratings	`one2many` → rating.rating	inverse: `res_id` inherited from mail.thread
website_message_ids	Website Messages Website communication history	`one2many` → mail.message	inverse: `res_id` inherited from mail.thread
create_date	Created on	`datetime`	read-onlyautomatic
create_uid	Created by	`many2one` → res.users	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` → res.users	read-onlyautomatic

Relations

Models linked from this model

crm.lead: lead_ids
crm.team: team_id
gamification.badge: certification_badge_id, certification_badge_id_dummy
hr.job: hr_job_ids
mail.template: certification_mail_template_id
res.lang: lang_ids
res.users: restrict_user_ids, user_id
slide.channel: slide_channel_ids
slide.slide: slide_ids
survey.question: page_ids, question_and_page_ids, question_ids, session_question_id
survey.user_input: user_input_ids

Fields of other models pointing here

crm.lead: origin_survey_id
gamification.badge: survey_id
hr.applicant: survey_id
hr.job: survey_id
hr.resume.line: survey_id
slide.slide: survey_id
survey.invite: survey_id
survey.question: survey_id
survey.user_input: survey_id
survey.user_input.line: survey_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

curl -X POST "https://your-instance.odoo.com/json/2/survey.survey/search_read" \
  -H "Authorization: bearer $ODOO_API_KEY" \
  -H "X-Odoo-Database: your-db" \
  -H "Content-Type: application/json" \
  -d '{"domain":[],"fields":["title","access_mode","questions_layout","questions_selection","scoring_type"],"limit":5}'

Python (requests)

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}/survey.survey/search_read",
    headers=headers,
    json={"domain": [], "fields": ["title","access_mode","questions_layout","questions_selection","scoring_type"], "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/survey-survey">survey.survey (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.