GET api/Lead/GetLeadByIdWithAddress?leadId={leadId}&includeAssociateContract={includeAssociateContract}

Request Information

URI Parameters

Name	Description	Type	Additional information
leadId		integer	Required
includeAssociateContract		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

LeadDTO

Name	Type	Additional information
LohOfficeId	integer	None.
PhoneCollections	Collection of LeadPhoneDTO	None.
EmailCollections	Collection of LeadEmailDTO	None.
LeadAdditionalAddresses	Collection of LeadAdditionalAddressDTO	None.
LeadAppointments	Collection of LeadAppointmentDTO	None.
IsEligibleForCreditSubmission	boolean	None.
comp	string	None.
HasLetter	boolean	None.
InfoVideoLink	string	None.
leadStatus	string	None.
LeadStatusId	integer	None.
StarredColorId	integer	None.
PrevLeadStatusId	integer	None.
AgentName	string	None.
LeadId	integer	None.
FirstName	string	None.
LastName	string	None.
AssociateId	integer	None.
TraineeAssociateId	integer	None.
AssociateContractId	integer	None.
Zip	string	None.
Address	string	None.
Address2	string	None.
GeoAddress	string	None.
PrimaryPhone	string	None.
PrimaryEmail	string	None.
FormattedPrimaryPhone	string	None.
SecondaryPhone	string	None.
FormattedSecondaryPhone	string	None.
BankTypeId	integer	None.
BankTypeName	string	None.
ResolutionId	integer	None.
ResolutionName	string	None.
ResolutionDate	date	None.
HasComment	boolean	None.
HasAppointment	boolean	None.
IsCalled	boolean	None.
IsBadPhoneNumber	boolean	None.
City	string	None.
CityId	integer	None.
StateCode	string	None.
State	string	None.
StateId	integer	None.
CountryId	integer	None.
Country	string	None.
GroupId	integer	None.
GroupName	string	None.
GroupCode	string	None.
GroupStatus	string	None.
IsHeld	boolean	None.
IsReserved	boolean	None.
HasAOAccess	boolean	None.
LeadOriginId	integer	None.
AltId	integer	None.
OfficeId	integer	None.
LeadOriginName	string	None.
LeadMarketplaceName	string	None.
MarketTypeId	integer	None.
isDialer	boolean	None.
AssignDate	date	None.
AssignDateString	string	None.
DateOfBirth	date	None.
_Age	integer	None.
Age	integer	None.
AgeOption	integer	None.
AgeString	string	None.
EnteredDate	date	None.
LatestAppointmentDateTime	date	None.
RecentlyPassedAppointmentDateTime	date	None.
LastUpdateDate	date	None.
LatestAppointmentDateTimeInString	string	None.
RecentlyPassedAppointmentDateTimeInString	string	None.
LastUpdateDateShortDateString	string	None.
Beneficiary	string	None.
MIRA	LeadRecentActivityDTO	None.
RecentActivities	Collection of LeadRecentActivityDTO	None.
LeadAWSUrl	string	None.
LeadAWSImageUrl	string	None.
Relationship	string	None.
HasAppointmentInThePast	boolean	None.
Email	string	None.
ReferredBy	string	None.
Referred	string	None.
Organization	string	None.
HasGiftCertificate	boolean	None.
Spouse	string	None.
Occupation	string	None.
NoOfChildren	integer	None.
NoOfKits	integer	None.
BranchOfService	string	None.
Notes	string	None.
GroupApproachVideoLink	string	None.
SalesTipsVideoLink	string	None.
DataSheetUri	string	None.
LastModifiedDate	date	None.
SecurityKeyword	string	None.
Source	string	None.
LastModifiedDateString	string	None.
ChangedByAssociateName	string	None.
ChangedBy	integer	None.
HasGroupApproachVideoLink	boolean	None.
HasSalesTipsVideoLink	boolean	None.
HasDataSheetUri	boolean	None.
FullName	string	None.
IsReferralLead	boolean	None.
IsSumbitForCreated	boolean	None.
IsPOSLead	boolean	None.
ChangeDate	date	None.
ChangeDateShortDateString	string	None.
DateofBirthShortDateString	string	None.
AssignDateShortDateString	string	None.
AssignDateShortDateStringWeb	string	None.
EnteredDateShortDateString	string	None.
ResolutionDateShortDateString	string	None.
ComposedAddress	string	None.
PrimaryLeadAddressLattitude	decimal number	None.
PrimaryLeadAddressLongitude	decimal number	None.
HasLeadGeoCoded	boolean	None.
MobileNumber	string	None.
FormattedMobileNumber	string	None.
LeadIndex	integer	None.
LeadComments	Collection of CommentDTO	None.
LatestComment	CommentDTO	None.
LatestCommentString	string	None.
AllowFreshenup	boolean	None.
AllowDatasheet	boolean	None.
IPrinted	boolean	None.
FPrinted	boolean	None.
PPrinted	boolean	None.
DPrinted	boolean	None.
APrinted	boolean	None.
LocationCode	string	None.
MiddleInitial	string	None.
PolicyNumber	string	None.
HouseHoldId	string	None.
AppointmentStatus	string	None.
OfficeName	string	None.
AssociateName	string	None.
Pool	string	None.
PrevPool	string	None.
AllPool	string	None.
LeadAssignmentGuid	globally unique identifier	None.
HasOfficerReport	boolean	None.
GroupType	string	None.
OfficerReportFormType	OfficerReportFormTypeEnum	None.
IsProLead	boolean	None.
AllowInfoCert	boolean	None.
AllowPOSLetter	boolean	None.
AllowPreApproachLetter	boolean	None.
HasReferralImages	boolean	None.
CreateDate	date	None.
CreateDateShortDateString	string	None.
ExpirationDate	integer	None.
SendAmberInvitaion	boolean	None.
ApiLeadImageUrl	string	None.
ParentOrGuardianName	string	None.
AgeOrDOB	string	None.
HasImage	boolean	None.
Policy	PolicyDTO	None.
C1Add	string	None.
isStateRestrictedLeadImage	boolean	None.
status	boolean	None.
userId	integer	None.
HideSelectionCheckbox	boolean	None.
GroupNotes	string	None.
NearestUpcomingApptTime	date	None.
AssignAgentName	string	None.
IsLookingForCareerUpdate	boolean	None.
isPreCallLetterAlreadySubmitted	boolean	None.
PreferredAppointmentTime	string	None.
CalculatedAge	integer	None.
Client	string	None.
TimezoneId	integer	None.
TimezoneOffset	decimal number	None.
TimezoneCode	string	None.
IsWorkingHour	boolean	None.
CurrentTimeOfLead	string	None.
Language	string	None.
ExpireLeadDaysCount	integer	None.
ExpireLeadDaysCountDetail	string	None.
ExpiryCounterHexColor	string	None.
DaysUntilExpiration	string	None.
LanguageId	integer	None.
LanguageDescription	string	None.
HowToVideoLink	string	None.
HasHowToVideoLink	boolean	None.
Inquiry	string	None.
WhatsYourStatus	string	None.
CurrentMembershipType	string	None.
MembershipId	string	None.
District	string	None.
Vso	string	None.
IsDNC	integer	None.
IsPrimaryDNC	boolean	None.
IsSecondaryDNC	boolean	None.
Post	string	None.
HasExpiryTag	boolean	None.
LeadExpiringColorCode	integer	None.
LeadTagDetailsDto	Collection of LeadTagDetailsDTO	None.
TagIds	Collection of integer	None.
TagNames	Collection of string	None.
HasLeadTags	boolean	None.
LastActionDate	date	None.
LastActionDateShortDateString	string	None.
GroupMarketPlaceId	integer	None.
LeadCardStatusField	string	None.
Affiliation	string	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.