Lead
Fields
Affiliate organization assigned to this lead.
Deprecation
The 'assignedToOrganization' field is deprecated.Please use 'assignedToTeamIdentifier' instead.
- Marked as deprecated on 2026-05-07.
- Scheduled for removal on or after 2026-07-07.
The identifier of the team the lead is assigned to.
Deprecation
The 'assignedToTeamIdentifier' field is deprecated.Lead-level assignment is being removed. Assignment is managed at Opportunity level.
- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.
The identifier of the user the lead is assigned to.
Deprecation
The 'assignedToUserIdentifier' field is deprecated.Lead-level assignment is being removed. Assignment is managed at Opportunity level.
- Marked as deprecated on 2026-05-19.
- Scheduled for removal on or after 2026-07-19.
The username of the user the lead is assigned to.
Deprecation
The 'assignedToUsername' field is deprecated.Please use 'assignedToUserIdentifier' instead.
- Marked as deprecated on 2026-04-22.
- Scheduled for removal on or after 2026-06-22.
The contacts for the lead.
Arguments
Input fields for retrieving contacts.
The type of the lead.
National Identifier of the lead.
Lead number.
List of opportunities for the lead.
Arguments
Input fields for retrieving opportunities.
The sales channel that this lead was captured by.
Deprecation
The 'salesChannel' field is deprecated.Sales channel information is being removed from the Lead model. This is information is saved in the Opportunity.
- Marked as deprecated on 2025-06-17.
- Scheduled for removal on or after 2025-10-17.
The sales funnel this lead is in.
The current stage of the sales funnel that this lead is in.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
Example
{
"contacts": [LeadContactDetailsType],
"leadType": "college-treat-defense-service-outside",
"nationalId": "44264608",
"number": "happy-future-fact-test-page",
"opportunities": [OpportunityOutput],
"salesFunnel": SalesFunnel,
"stage": SalesFunnelStage
}