Page Comparison

This method returns information related with a lead. A

Tip
Available from CRM.COM R5.0.0
Excerpt
Excerpt
This method returns information related with a lead. A single lead is returned by each call

...

Name

Type

Description

token

String

The token retrieved from the login method

lead_identifier

(mandatory)

Lead identifier

The identifier of the lead that should be returned as a result. The allowed lead identifier fields are the following:

Include Page

	V4:lead_identifier
	V4:lead_identifier

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Expand

title	Example 1

HTTP Method: GET

Request: http://host_name/crmapi/rest/v2/leads/show?token=6B6300203CBC420900E2B585934F682A&lead_identifier=number=19

Response:

Code Block

language	js

    {
       "actual_completion_date": null,
       "services_set":
       [
           {
               "product_type":
               {
                   "service_type": "TERMED",
                   "physical_good_type": null,
                   "used_for_provisioning": true,
                   "classification": "SERVICES",
                   "composition_method": "FLAT",
                   "id": "BC954969D3172372D498D3BB2BA590A0",
                   "name": "Subscription Packages",
                   "description": "Subscription main packages",
                   "alternative_code": "SP"
               },
               "id": "818ACD56DD994089AF923191485CBC63",
               "product": null
           },
           {
               "product_type": null,
               "id": "CDEA1D2998BD4998B36ACF034CCD9B94",
               "product":
               {
                   "product_type":
                   {
                       "service_type": "TERMED",
                       "physical_good_type": null,
                       "used_for_provisioning": true,
                       "classification": "SERVICES",
                       "composition_method": "FLAT",
                       "id": "BC954969D3172372D498D3BB2BA590A0",
                       "name": "Subscription Packages",
                       "description": "Subscription main packages",
                       "alternative_code": "SP"
                   },
                   "id": "3FACF409E7E091F96C52318BAD1AEF1C",
                   "description": "Local + Documentaries + Sport",
                   "code": "Local + Documentaries + Sport",
                   "alternative_code": "LDS"
               }
           },
           {
               "product_type": null,
               "id": "7ED5C781182C472989231A66620198D4",
               "product":
               {
                   "product_type":
                   {
                       "service_type": "TERMED",
                       "physical_good_type": null,
                       "used_for_provisioning": true,
                       "classification": "SERVICES",
                       "composition_method": "FLAT",
                       "id": "BC954969D3172372D498D3BB2BA590A0",
                       "name": "Subscription Packages",
                       "description": "Subscription main packages",
                       "alternative_code": "SP"
                   },
                   "id": "EFE959954792C2CA46A9147311DE6C94",
                   "description": "Local + Documentaries + Int.",
                   "code": "Local + Documentaries + Int.",
                   "alternative_code": "LDI"
               }
           },
           {
               "product_type": null,
               "id": "ED93E63B8B454F39B097ADA62E826E86",
               "product":
               {
                   "product_type":
                   {
                       "service_type": "TERMED",
                       "physical_good_type": null,
                       "used_for_provisioning": true,
                       "classification": "SERVICES",
                       "composition_method": "FLAT",
                       "id": "BC954969D3172372D498D3BB2BA590A0",
                       "name": "Subscription Packages",
                       "description": "Subscription main packages",
                       "alternative_code": "SP"
                   },
                   "id": "9A345FDBF378829368733CCB7472E301",
                   "description": "Combo - All available channels",
                   "code": "Combo - All available channels",
                   "alternative_code": "C-AAC"
               }
           }
       ],
       "udf_float_1": null,
       "udf_float_2": null,
       "udf_float_3": null,
       "udf_float_4": null,
       "udf_string_1": null,
       "assigned_to":
       {
           "unit": null,
           "user":
           {
               "person_name": "Smanager",
               "username": "Smanager",
               "id": "DCA93D75753E5CC5AD1E69556368E616",
               "email": null
           }
       },
       "udf_string_2": null,
       "privacy_level": null,
       "contact_information":
       {
           "last_name": "Lannister",
           "middle_name": null,
           "life_cycle_state": "FINANCIAL",
           "company_profile": null,
           "title": "Mr",
           "first_name": "Marios",
           "type": "PERSON",
           "id": "F60EF6A65658F86B3DFADA3809BD85C4",
           "name": null,
           "company_name": null,
           "demographics":
           {
               "gender": "MALE",
               "passport_issued_by_country": null,
               "social_security_number": null,
               "passport_number": null,
               "industry_sector": null,
               "name_day":
               {
                   "month": 5,
                   "day": 1
               },
               "date_of_birth":
               {
                   "month": 5,
                   "day": 1,
                   "year": 1963
               },
               "id_number": "593664",
               "industry": null
           }
       },
       "udf_string_3": null,
       "udf_string_4": null,
       "udf_string_5": null,
       "udf_string_6": null,
       "physical_goods_set":
       [
           {
               "product_type":
               {
                   "service_type": null,
                   "physical_good_type": "TRACEABLE",
                   "used_for_provisioning": false,
                   "classification": "PHYSICALGOODS",
                   "composition_method": "FLAT",
                   "id": "A1508BD642EC10858A54266C6945A8C2",
                   "name": "Monitors",
                   "description": "Monitors For Jobs",
                   "alternative_code": "MO"
               },
               "id": "2E4DC10D1608424896C72CE65E4368E5",
               "product": null
           },
           {
               "product_type":
               {
                   "service_type": null,
                   "physical_good_type": "TRACEABLE",
                   "used_for_provisioning": true,
                   "classification": "PHYSICALGOODS",
                   "composition_method": "FLAT",
                   "id": "249F5EA21B317E4B7BB6F696E7496F03",
                   "name": "Modem",
                   "description": "Modem",
                   "alternative_code": "MODEM"
               },
               "id": "FB717C0DE5A94BD692951CAC7AFC78FE",
               "product": null
           },
           {
               "product_type": null,
               "id": "6720CD24EE934498B99565065BE835DF",
               "product":
               {
                   "product_type":
                   {
                       "service_type": null,
                       "physical_good_type": "TRACEABLE",
                       "used_for_provisioning": true,
                       "classification": "PHYSICALGOODS",
                       "composition_method": "FLAT",
                       "id": "249F5EA21B317E4B7BB6F696E7496F03",
                       "name": "Modem",
                       "description": "Modem",
                       "alternative_code": "MODEM"
                   },
                   "id": "6F55D5C056F35939CC503AD7ACFB9CD5",
                   "description": "Modem A+ Class",
                   "code": "Modem A+",
                   "alternative_code": "MA"
               }
           }
       ],
       "udf_string_7": null,
       "udf_string_8": null,
       "accounts_receivable":
       {
           "account_owner":
           {
               "last_name": "Lannister",
               "middle_name": null,
               "life_cycle_state": "FINANCIAL",
               "company_profile": null,
               "title": "Mr",
               "first_name": "Marios",
               "type": "PERSON",
               "id": "F60EF6A65658F86B3DFADA3809BD85C4",
               "name": null,
               "company_name": null,
               "demographics":
               {
                   "gender": "MALE",
                   "passport_issued_by_country": null,
                   "social_security_number": null,
                   "passport_number": null,
                   "industry_sector": null,
                   "name_day":
                   {
                       "month": 5,
                       "day": 1
                   },
                   "date_of_birth":
                   {
                       "month": 5,
                       "day": 1,
                       "year": 1963
                   },
                   "id_number": "593664",
                   "industry": null
               }
           },
           "life_cycle_state": "ACTIVE",
           "number": "4",
           "id": "5C7045E4DCE86FE0670CEE3A32437227",
           "name": "mar"
       },
       "id": "7E4D45DD4000EB8B71CC5656A6C93C03",
       "priority": 2,
       "expected_completion_date": "2015-05-13T09:52:09",
       "users_set":
       [
           {
               "user":
               {
                   "person_name": "x_poulli",
                   "username": "x_poulli",
                   "id": "D0B5657F42ED3331694BAE21DF971807",
                   "email": "s@s.s2"
               },
               "id": "0D2ABD57DA7F9AFA9A293F8841DE4E25"
           }
       ],
       "time_overdue":
       {
           "time_period_value": null,
           "time_period_uot": null
       },
       "time_to_completion":
       {
           "time_period_value": 2,
           "time_period_uot": "MONTHS"
       },
       "log_information":
       {
           "updated_date": "2015-03-12T11:24:38",
           "created_date": "2015-02-13T09:52:09",
           "created_by_unit":
           {
               "id": "48305F8849E3C18B227C5BE3A27BA6DF",
               "name": "Admin Unit",
               "group_name": "Main Group",
               "description": "r1",
               "alternative_code": "MG"
           },
           "updated_by_unit":
           {
               "id": "48305F8849E3C18B227C5BE3A27BA6DF",
               "name": "Admin Unit",
               "group_name": "Main Group",
               "description": "r1",
               "alternative_code": "MG"
           },
           "created_by_user":
           {
               "person_name": "Marios Lannister",
               "username": "mpadministrator",
               "id": "1"
           },
           "updated_by_user":
           {
               "person_name": "Marios Lannister",
               "username": "mpadministrator",
               "id": "1"
           }
       },
       "life_cycle_state": "IN_PROGRESS",
       "type":
       {
           "id": "F60FFE7AAD3F5B9B6E66A42266FA37C4",
           "name": "Software Purchase",
           "description": null,
           "alternative_code": "SP"
       },
       "contact_email": "photos.panayi@crm.com",
       "lost_reason": null,
       "target_amount": null,
       "number": "19",
       "competitors_set":
       [
       ],
       "estimated_completion_time":
       {
           "time_period_value": 3,
           "time_period_uot": "MONTHS"
       },
       "lead_source":
       {
           "recommended_by_employee":
           {
               "person_name": "Marios Lannister",
               "username": "mpadministrator",
               "id": "1",
               "email": "mp@ministrator.com"
           },
           "type": "RECOMMENDEDBYEMPLOYEE"
       },
       "probability_to_win": null,
       "udf_date_1": null,
       "udf_date_2": null,
       "udf_date_3": null,
       "start_date": "2015-02-13T09:52:09",
       "udf_date_4": null,
       "owned_by_group":
       {
           "id": "84F33366CB592BAAE7E2044D93611C6A",
           "name": "Main Group",
           "description": "Main Group",
           "alternative_code": "das"
       },
       "status":
       {
           "id": "B738753EE56D01FC6CD964D14FBBCC7A",
           "name": "Interest",
           "description": null,
           "alternative_code": "I"
       },
       "importance": "IMPORTANCE1",
       "description": null,
       "category":
       {
           "id": "C60F332D0B4CB8DD22A0159413951434",
           "name": "Software Purchase",
           "description": null,
           "code": "SP"
       }
    }

Expand

title	Example 2

HTTP Method: GET

Request: {{server}}/crmapi/rest/v2/leads/show?token={{token}}&lead_identifier=number=116

Response:

Code Block

language	js

   {
    "data": {
        "target_amount": null,
        "contact_phone": null,
        "log_information": {
            "created_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "updated_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "created_date": "2018-01-16T08:39:43",
            "updated_date": "2018-01-16T23:28:59",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "Eleni 3 Michailidou",
                "id": "9A2CF58F91D94B8B981C33275BA20880",
                "email": "e_michailidou@crm.com",
                "username": "emichailidou"
            }
        },
        "importance": "IMPORTANCE1",
        "subscription_package": {
            "subscription_package": {
                "alternative_code": "Pania Package",
                "name": "Pania Package",
                "description": null,
                "id": "0B949625E4484651BC3D4F8B85A7FA4E",
                "classification": "PACKAGE"
            }
        },
        "lead_source": {
            "type": "RECOMMENDEDBYCONTACT"
        },
        "owned_by_group": {
            "alternative_code": "MG",
            "community_name": "Community",
            "name": "Main Group",
            "description": "Main Group",
            "id": "1"
        },
        "description": null,
        "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": null,
            "last_name": "Test Leads",
            "id": "7165977015D54B93B5FC9B3833C5A1FF",
            "life_cycle_state": "FINANCIAL",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Eleni",
            "demographics": {
                "name_day": {
                    "month": null,
                    "day": null
                },
                "id_number": null,
                "gender": null,
                "country_of_residence": {
                    "alternative_code": "CYP",
                    "three_character_code": "CYP",
                    "name": "CYPRUS",
                    "id": "181",
                    "two_character_code": "CY"
                },
                "date_of_birth": {
                    "month": null,
                    "year": null,
                    "day": null
                },
                "industry_sector": null,
                "passport_number": null,
                "industry": null,
                "social_security_number": null,
                "id_issued_by_country": null,
                "passport_issued_by_country": null
            }
        },
        "type": {
            "alternative_code": "TPMC",
            "name": "3-Play Mall Campaign",
            "description": null,
            "id": "2783ED2B25B242A78D450A10818FD54F"
        },
        "udf_date_2": null,
        "udf_date_1": null,
        "products_set": [
            {
                "product_family": {
                    "code": "CH",
                    "name": "Channels",
                    "description": null,
                    "id": "5432773B865246E3B10A47CD130183C7"
                },
                "product": null,
                "product_type": null,
                "id": "91F6B5459FC642CFB44BE46A0F22E523",
                "product_brand": null
            },
            {
                "product_family": null,
                "product": null,
                "product_type": null,
                "id": "F7D86F21653E417FB6C4D1AE665A0C41",
                "product_brand": {
                    "alternative_code": "CS",
                    "name": "Corso Shoes",
                    "description": null,
                    "id": "5A917782ACA648B3BEAF417D1E64C43F"
                }
            },
            {
                "product_family": null,
                "product": null,
                "product_type": {
                    "meter_reading_type": null,
                    "service_type": "TERMED",
                    "used_for_provisioning": true,
                    "alternative_code": "AS",
                    "udr_type": null,
                    "composition_method": "FLAT",
                    "name": "Additional Services",
                    "description": null,
                    "id": "C8321F0BCA8A4051857BC35CEEE41555",
                    "classification": "SERVICES",
                    "physical_good_type": null
                },
                "id": "80160D5A245B4D0380A73D212E228131",
                "product_brand": null
            },
            {
                "product_family": null,
                "product": {
                    "code": "Abstract Physical Good",
                    "product_type": {
                        "meter_reading_type": null,
                        "service_type": null,
                        "used_for_provisioning": true,
                        "alternative_code": "Physical Good",
                        "udr_type": null,
                        "composition_method": "FLAT",
                        "name": "Physical Good",
                        "description": null,
                        "id": "5B6DAF4AD7C94C4D9C3B49950E10B256",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "TRACEABLE"
                    },
                    "alternative_code": "APG",
                    "description": "Abstract Physical Good",
                    "id": "754BEFEB2C324667A869808E1E7A350F",
                    "priority_level": null
                },
                "product_type": null,
                "id": "A671AACDFC6145338241DB307EFCDF2C",
                "product_brand": null
            }
        ],
        "udf_date_4": null,
        "contact_email": null,
        "udf_date_3": null,
        "number": "116",
        "udf_float_3": null,
        "udf_float_4": null,
        "estimated_completion_time": {
            "time_period_uot": "WEEKS",
            "time_period_value": 2
        },
        "probability_to_win": null,
        "id": "68B216C3A0E14173B48ED3FF4EB11182",
        "udf_float_1": null,
        "udf_float_2": null,
        "start_date": "2018-01-16T08:39:43",
        "assigned_to": {
            "unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "user": {
                "person_name": "Eleni 3 Michailidou",
                "id": "9A2CF58F91D94B8B981C33275BA20880",
                "email": "e_michailidou@crm.com",
                "username": "emichailidou"
            }
        },
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "actual_completion_date": null,
        "udf_string_5": null,
        "privacy_level": null,
        "users_set": [],
        "udf_string_1": null,
        "accounts_receivable": {
            "number": "ACR0000001957",
            "name": "ACR0000001957 Eleni Test Leads",
            "id": "3FDD108E7CC74B0EB11ACC473A05E19F",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": null,
                "last_name": "Test Leads",
                "id": "7165977015D54B93B5FC9B3833C5A1FF",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Eleni",
                "demographics": {
                    "name_day": {
                        "month": null,
                        "day": null
                    },
                    "id_number": null,
                    "gender": null,
                    "country_of_residence": {
                        "alternative_code": "CYP",
                        "three_character_code": "CYP",
                        "name": "CYPRUS",
                        "id": "181",
                        "two_character_code": "CY"
                    },
                    "date_of_birth": {
                        "month": null,
                        "year": null,
                        "day": null
                    },
                    "industry_sector": null,
                    "passport_number": null,
                    "industry": null,
                    "social_security_number": null,
                    "id_issued_by_country": null,
                    "passport_issued_by_country": null
                }
            }
        },
        "life_cycle_state": "IN_PROGRESS",
        "priority": 1,
        "time_to_completion": {
            "time_period_uot": "WEEKS",
            "time_period_value": 1.1428571428571428
        },
        "lost_reason": null,
        "competitors_set": [
            {
                "competitor": {
                    "website": null,
                    "name": "MagnaQuest",
                    "description": null,
                    "id": "640A12797E964BFC99F8AF0EA538EEEA"
                },
                "id": "270455D963CA4059B93AEE4028D30A8E"
            },
            {
                "competitor": {
                    "website": "Zuora.com",
                    "name": "Zuora",
                    "description": null,
                    "id": "0CC8A3BDCA7B41B78058D0A178390B06"
                },
                "id": "9CC1CA44F25B4A7C962E032B58905DED"
            },
            {
                "competitor": {
                    "website": null,
                    "name": "Competitor 2",
                    "description": null,
                    "id": "9A63A715C5174BD4B70FBE49EAC79815"
                },
                "id": "A0FF7979362946F98590D8964F06485F"
            }
        ],
        "time_overdue": {
            "time_period_uot": null,
            "time_period_value": null
        },
        "category": {
            "code": "TA",
            "name": "TV Advert",
            "description": null,
            "id": "614B3A5B38A942E6A74052C4F4606573"
        },
        "udf_string_6": null,
        "expected_completion_date": "2018-01-30T08:39:43",
        "udf_string_7": null,
        "udf_string_8": null,
 },        "status":        {{
            "idalternative_code": "B738753EE56D01FC6CD964D14FBBCC7AINT",
            "name": "Interest",
            "description": null,
            "alternative_codeid": "I"
       },
   C5C0EEDEC510465F963E1772E56A5B9C",
   "importance": "IMPORTANCE1",        "descriptionlife_cycle_state": null,
       "category":"IN_PROGRESS"
       { }
    },
     "idstatus": "C60F332D0B4CB8DD22A0159413951434",{
           "namecode": "Software PurchaseOK",
 
         "description": null"",
           "codemessage": "SP"
    }
  }
 
  }

Versions Compared

Old Version 1

New Version Current

Key