Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Name

Type

Description

id

String

The ID of the retrieved lead

number

String

The number of the retrieved lead 

contact_emailStringThe email address of the contact as specified on the retrieved lead
goal
contact_phoneString

The

goal

phone of the

retrieved leadstageStringThe stage of The probability to win the retrieved lead which can vary from 0 to 100

contact as specified on the retrieved lead

probability_to_winNumber
Tip

Available from CRM.COM R11.1.0


descriptionStringThe description of the retrieved
lead 
lead 

life_cycle_state

String

The life cycle state of the retrieved lead which can be PENDING, IN_PROGRESS, LOST, WON, CANCELLED

Tip

CANCELLED life cycle state available from CRM.COM R11.1.0


probability_to_winNumberThe probability to win the retrieved lead which can vary from 0 to 100
importanceString

The importance of the retrieved lead, which can be one of the following:

IMPORTANCE1, IMPORTANCE2, IMPORTANCE3, IMPORTANCE4, IMPORTANCE5, CUSTOM1, CUSTOM2 , CUSTOM3

priorityString

The priority level of the retrieved lead, which can be one of the following:

PRIORITY1

1,

PRIORITY2

2,

PRIORITY3

3,

CUSTOM1

4,

CUSTOM2

5,

CUSTOM3

6

goal
target_amountNumberThe amount that is predicted to be gained when winning
the retrieved leadlead_revenueNumberThe retrieved lead revenuecompetitors The competitors that can reach the same retrieved lead for
the
same product/goallost_reasonStringThe reason that the retrieved lead was lost, if the
retrieved lead
status is lost
source_typeStringThe source type of the retrieved lead, which can be: ADVERTISEMENT, NOTIFICATIONS, COMMUNICATIONS, RECOMMENDED_BY_CONTACT, RECOMMENDED_BY_EMPLOYEE, RECOMMENDED_BY_PARTNER, WEBSITE, OTHER, CUSTOM1, CUSTOM2, CUSTOM3source_nameStringThe name of the source of the retrieved lead
start_dateDateThe date that the lead is created
expected_completion_dateDateThe date that the lead is expected to be completed
actual_
completed
completion_dateDateThe date that the lead is actually completed

udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date

lead_sourceLead Source ObjectThe source related with the specified lead and lead source type

accounts_receivable

Accounts Receivable object

The accounts receivable related with the specified lead

contact_information
 Contact
Contact Information objectThe contact information related with the specified lead 
lead_ownerUser object

The user who owns the specified lead

Tip

Available from CRM.COM R15.0.0


assigned_toAssign ObjectThe assignment information of the retrieved lead
type
lead
Lead type objectThe type information of the retrieved lead
status
lead
Lead Status objectThe status information of the retrieved lead
lost_reasonLead Lost Reason ObjectThe reason that the Lead was lost.
category
lead
Lead Category objectThe category of the retrieved lead
estimated_completion_timeTime Period ObjectThe time that is estimated to complete the lead, measured in minutes, hours, days, weeks, years
time_to_completionTime Period ObjectThe time that is left up to the expected completion date
time_overdueTime Period ObjectThe time past the expected completion date
owned_by_groupGroup object

The group that is owning the lead

Tip

Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit)


owned_by_business_unitBusiness Unit Object

The business unit that is owning the lead

Tip

Available from CRM.COM R18.0.0


privacy_levelPrivacy level object

The privacy level of the lead

Tip

Deprecated from CRM.COM R18.0.0


log_information

Log Information Object

The log information related with the retrieved lead

activities
competitors_setSet of
Activities communications
Lead Competitor Objects
A list of activities which are planned for the retrieved lead

A lists of all possible competitors that can reach the same Lead for the same product/goal.

Tip

From CRM.COM R18.0.0, competitors are referring to company contact information


users_setSet of
Communications Objects
Lead UsersA list of
communications sent to the retrieved leadservices
Users that are set as the team involved with the lead
products_setSet of
Services
Lead Products Objects

A list of

services

products for which the lead was

raised forphysical_goods_setSet of Physical Goods ObjectsA list of the physical goods

taken for

Tip

Available from CRM.COM R14

Up to CRM.COM R17.0.0, products refer only to physical goods and services


subscription_package

Subscription Package Object

The subscription packages for which the retrieved lead was

raised for, which can be traceable or not traceable

taken for

Tip

Available from CRM.COM R14


Tip

Deprecated from CRM.COM R18.0.0


Anchor
leads referred objects
leads referred objects
Referred Objects Response Data

Include Page
lead_source_short
lead_source_short

Include Page
accounts_receivable_short
accounts_receivable_short

Include Page
contact_information_short
contact_information_short

Include Page
user_short
user_short

Include Page
assigned_to_short
assigned_to_short

Include Page
service_requestlead_type_short
lead_type_shortservice_request_type

Include Page
lead_status_short
lead_status_short

Include Page
servicelead_requestlost_statusreason_shortservice
lead_requestlost_statusreason_short

Include Page
service_requestlead_category_shortservice_request
lead_category_short

Include Page
time_period_short
time_period_short

...

Include Page
log_information_short
log_information_short

Include Page
servicelead_requestsusers_referring_to_shortservice_requests_referring_to
lead_users_short

Include Page
servicelead_requestcompetitors_response_shortservice
lead_requestcompetitors_response_short

Include Page
service_request_temporary_resolutionlead_services_shortservice_request_temporary_resolution
lead_services_short

Include Page
servicelead_requestphysical_finalgoods_resolution_shortservice
lead_requestphysical_final_resolutiongoods_short

Include Page
servicelead_requestsubscription_servicespackages_shortservice
lead_requestsubscription_servicespackages_short

Include Page
service_request_physical_goodsbusiness_unit_shortservice_request_physical_goods_short
Include Page
related_service_request_shortrelated_service_requestbusiness_unit_short