Odoo 19.0 Community · Persistent

crm.lead: fields, relations and API

The crm.lead model ("Lead") is a persistent model declared by the CRM module, then extended by 13 other modules. It exposes 134 fields, 95 of them declared directly on the model; 15 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: crm.lead
Label: Lead
Type: Persistent (models.Model)
SQL table: crm_lead
Origin module: CRM (crm)
Extended by: iap_crm, crm_iap_enrich, crm_iap_mine, crm_livechat, crm_mail_plugin, event_crm, sale_crm, mass_mailing_crm, survey_crm, website_crm, website_crm_iap_reveal, website_crm_livechat, website_crm_partner_assign
Default order (_order): priority desc, id desc
Inherits from (mixins): mail.thread.cc mail.thread.blacklist mail.thread.phone mail.activity.mixin utm.mixin format.address.mixin mail.tracking.duration.mixin

Model fields

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

Hide inherited fields

134 of 134 fields shown

Technical name	Label	Type	Details
active	Active	`boolean`
automated_probability	Automated Probability	`float`	read-onlycomputed, stored
calendar_event_ids	Meetings	`one2many` → calendar.event	inverse: `opportunity_id`
campaign_id	Campaign	`many2one` → utm.campaign
city	City	`char`	computed, stored
color	Color Index	`integer`
commercial_partner_id	Customer Company	`many2one` → res.partner	computed
company_currency	Currency	`many2one` → res.currency	computed
company_id	Company	`many2one` → res.company	computed, stored
contact_name	Contact Name	`char`	computed, stored
country_id	Country	`many2one` → res.country	computed, stored
date_automation_last	Last Action	`datetime`	read-only
date_closed	Closed Date	`datetime`	read-only
date_conversion	Conversion Date	`datetime`	read-only
date_deadline	Expected Closing Estimate of the date on which the opportunity will be won.	`date`
date_last_stage_update	Last Stage Update	`datetime`	read-onlycomputed, stored
date_open	Assignment Date	`datetime`	read-onlycomputed, stored
date_partner_assign	Partner Assignment Date Last date this case was forwarded/assigned to a partner	`date`	computed, stored added by Resellers (`website_crm_partner_assign`)
day_close	Days to Close	`float`	computed, stored
day_open	Days to Assign	`float`	computed, stored
description	Notes	`html`
duplicate_lead_count	Potential Duplicate Lead Count	`integer`	computed
duplicate_lead_ids	Potential Duplicate Lead	`many2many` → crm.lead	computed
email_domain_criterion	Email Domain Criterion	`char`	computed, stored
email_from	Email	`char`	computed, stored
email_normalized	Email Normalized	`char`
email_state	Email Quality	`selection`	computed, stored Values: `correct` (Correct), `incorrect` (Incorrect)
event_id	Source Event Event triggering the rule that created this lead	`many2one` → event.event	added by Event CRM (`event_crm`)
event_lead_rule_id	Registration Rule Rule that created this lead	`many2one` → event.lead.rule	added by Event CRM (`event_crm`)
expected_revenue	Expected Revenue	`monetary`
function	Job Position	`char`	computed, stored
iap_enrich_done	Enrichment done Whether IAP service for lead enrichment based on email has been performed on this lead.	`boolean`	added by Lead Enrichment (`crm_iap_enrich`)
is_automated_probability	Is automated probability?	`boolean`	computed
is_partner_visible	Is Partner Visible	`boolean`	computed
lang_active_count	Lang Active Count	`integer`	computed
lang_code	Lang Code	`char`	related: `lang_id.code`
lang_id	Language	`many2one` → res.lang	computed, stored
lead_mining_request_id	Lead Mining Request	`many2one` → crm.iap.lead.mining.request	added by Lead Generation (`crm_iap_mine`)
lead_properties	Properties	`properties`
lost_reason_id	Lost Reason	`many2one` → crm.lost.reason
medium_id	Medium	`many2one` → utm.medium
meeting_display_date	Meeting Display Date	`date`	computed
meeting_display_label	Meeting Display Label	`char`	computed
name	Opportunity	`char`	requiredcomputed, stored
order_ids	Orders	`one2many` → sale.order	inverse: `opportunity_id` added by Opportunity to Quotation (`sale_crm`)
origin_channel_id	Live chat from which the lead was created	`many2one` → discuss.channel	read-only added by CRM Livechat (`crm_livechat`)
origin_survey_id	Survey	`many2one` → survey.survey	added by Survey CRM (`survey_crm`)
partner_assigned_id	Assigned Partner	`many2one` → res.partner	added by Resellers (`website_crm_partner_assign`)
partner_declined_ids	Partner not interested	`many2many` → res.partner	added by Resellers (`website_crm_partner_assign`)
partner_email_update	Partner Email will Update	`boolean`	computed
partner_id	Contact Linked partner (optional). Usually created when converting the lead. You can find a partner by its Name, TIN, Email or Internal Reference.	`many2one` → res.partner
partner_is_blacklisted	Partner is blacklisted	`boolean`	read-only related: `partner_id.is_blacklisted`
partner_latitude	Geo Latitude	`float`	added by Resellers (`website_crm_partner_assign`)
partner_longitude	Geo Longitude	`float`	added by Resellers (`website_crm_partner_assign`)
partner_name	Company Name The name of the future partner company that will be created while converting the lead into opportunity	`char`	computed, stored
partner_phone_update	Partner Phone will Update	`boolean`	computed
phone	Phone	`char`	computed, stored
phone_sanitized	Phone Sanitized	`char`
phone_state	Phone Quality	`selection`	computed, stored Values: `correct` (Correct), `incorrect` (Incorrect)
priority	Priority	`selection`	Values: `0` (Low), `1` (Medium), `2` (High), `3` (Very High)
probability	Probability	`float`	computed, stored
prorated_revenue	Prorated Revenue	`monetary`	computed, stored
quotation_count	Number of Quotations	`integer`	computed added by Opportunity to Quotation (`sale_crm`)
recurring_plan	Recurring Plan	`many2one` → crm.recurring.plan
recurring_revenue	Recurring Revenues	`monetary`
recurring_revenue_monthly	Expected MRR	`monetary`	computed, stored
recurring_revenue_monthly_prorated	Prorated MRR	`monetary`	computed, stored
recurring_revenue_prorated	Prorated Recurring Revenues	`monetary`	computed, stored
referred	Referred By	`char`
registration_count	# Registrations Counter for the registrations linked to this lead	`integer`	computed added by Event CRM (`event_crm`)
registration_ids	Source Registrations Registrations triggering the rule that created this lead	`many2many` → event.registration	added by Event CRM (`event_crm`)
reveal_iap_credits	IAP Credits	`integer`	added by Lead Generation From Website Visits (`website_crm_iap_reveal`)
reveal_id	Reveal ID	`char`	added by IAP / CRM (`iap_crm`)
reveal_ip	IP Address	`char`	added by Lead Generation From Website Visits (`website_crm_iap_reveal`)
reveal_rule_id	Lead Generation Rule	`many2one` → crm.reveal.rule	added by Lead Generation From Website Visits (`website_crm_iap_reveal`)
sale_amount_total	Sum of Orders Untaxed Total of Confirmed Orders	`monetary`	computed added by Opportunity to Quotation (`sale_crm`)
sale_order_count	Number of Sale Orders	`integer`	computed added by Opportunity to Quotation (`sale_crm`)
show_enrich_button	Allow manual enrich	`boolean`	computed added by Lead Enrichment (`crm_iap_enrich`)
source_id	Source	`many2one` → utm.source
stage_id	Stage	`many2one` → crm.stage	computed, stored
stage_id_color	Stage Color	`integer`	related: `stage_id.color`
state_id	State	`many2one` → res.country.state	computed, stored
street	Street	`char`	computed, stored
street2	Street2	`char`	computed, stored
tag_ids	Tags Classify and analyze your lead/opportunity categories like: Training, Service	`many2many` → crm.tag
team_id	Sales Team	`many2one` → crm.team	computed, stored
type	Type	`selection`	required Values: `lead` (Lead), `opportunity` (Opportunity)
user_company_ids	User Company UX: Limit to lead company or all if no company	`many2many` → res.company	computed
user_id	Salesperson	`many2one` → res.users
visitor_ids	Web Visitors	`many2many` → website.visitor	added by Contact Form (`website_crm`)
visitor_page_count	# Page Views	`integer`	computed added by Contact Form (`website_crm`)
visitor_sessions_count	# Sessions	`integer`	computed added by Lead Livechat Sessions (`website_crm_livechat`)
website	Website Website of the contact	`char`	computed, stored
won_status	Won/Lost	`selection`	computed, stored Values: `won` (Won), `lost` (Lost), `pending` (Pending)
zip	Zip	`char`	computed, stored
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
duration_tracking	Status time JSON that maps ids from a many2one field to seconds spent	`json`	computed inherited from mail.tracking.duration.mixin
email_cc	Email cc	`char`	inherited from mail.thread.cc
has_message	Has Message	`boolean`	computed inherited from mail.thread
is_blacklisted	Blacklist If the email address is on the blacklist, the contact won't receive mass mailing anymore, from any list	`boolean`	computed inherited from mail.thread.blacklist
is_rotting	Rotting	`boolean`	computed inherited from mail.tracking.duration.mixin
message_attachment_count	Attachment Count	`integer`	computed inherited from mail.thread
message_bounce	Bounce Counter of the number of bounced emails for this contact	`integer`	inherited from mail.thread.blacklist
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
phone_blacklisted	Blacklisted Phone is Phone Indicates if a blacklisted sanitized phone number is a phone number. Helps distinguish which number is blacklisted when there is both a mobile and phone field in a model.	`boolean`	computed inherited from mail.thread.phone
phone_mobile_search	Phone Number	`char`	inherited from mail.thread.phone
phone_sanitized_blacklisted	Phone Blacklisted If the sanitized phone number is on the blacklist, the contact won't receive mass mailing sms anymore, from any list	`boolean`	computed inherited from mail.thread.phone
rating_ids	Ratings	`one2many` → rating.rating	inverse: `res_id` inherited from mail.thread
rotting_days	Days Rotting Day count since this resource was last updated	`integer`	computed inherited from mail.tracking.duration.mixin
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

calendar.event: calendar_event_ids
crm.iap.lead.mining.request: lead_mining_request_id
crm.lead: duplicate_lead_ids
crm.lost.reason: lost_reason_id
crm.recurring.plan: recurring_plan
crm.reveal.rule: reveal_rule_id
crm.stage: stage_id
crm.tag: tag_ids
crm.team: team_id
discuss.channel: origin_channel_id
event.event: event_id
event.lead.rule: event_lead_rule_id
event.registration: registration_ids
res.company: company_id, user_company_ids
res.country: country_id
res.country.state: state_id
res.currency: company_currency
res.lang: lang_id
res.partner: commercial_partner_id, partner_assigned_id, partner_declined_ids, partner_id
res.users: user_id
sale.order: order_ids
survey.survey: origin_survey_id
utm.campaign: campaign_id
utm.medium: medium_id
utm.source: source_id
website.visitor: visitor_ids

Fields of other models pointing here

calendar.event: opportunity_id
crm.activity.report: lead_id
crm.lead: duplicate_lead_ids
crm.lead.assignation: lead_id
crm.lead.lost: lead_ids
crm.lead2opportunity.partner: duplicated_lead_ids, lead_id
crm.lead2opportunity.partner.mass: lead_id, lead_tomerge_ids
crm.merge.opportunity: opportunity_ids
crm.quotation.partner: lead_id
event.registration: lead_ids
sale.order: opportunity_id
survey.user_input: lead_id
website.visitor: lead_ids

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/crm.lead/search_read" \
  -H "Authorization: bearer $ODOO_API_KEY" \
  -H "X-Odoo-Database: your-db" \
  -H "Content-Type: application/json" \
  -d '{"domain":[],"fields":["name","type","campaign_id","company_id","country_id"],"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}/crm.lead/search_read",
    headers=headers,
    json={"domain": [], "fields": ["name","type","campaign_id","company_id","country_id"], "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/crm-lead">crm.lead (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.