Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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
titleExample 2

HTTP Method: GET

 

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

Response:

Code Block
languagejs
   {
    "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,
        "udfproducts_date_4set": [
null,         "contact_email": null,  {
      "udf_date_3": null,         "numberproduct_family": "116", {
          "udf_float_3": null,         "udf_float_4""code": null"CH",
 
      "estimated_completion_time": {             "time_period_uotname": "WEEKSChannels",
             "time_period_value": 2      "description": null,
 },         "probability_to_win": null,         "id": "68B216C3A0E14173B48ED3FF4EB111825432773B865246E3B10A47CD130183C7",
  
     "udf_float_1": null,         "udf_float_2": null,
  },
      "start_date": "2018-01-16T08:39:43",         "assigned_toproduct": null,
   {             "unitproduct_type": {null,
                "alternative_codeid": "adminunit91F6B5459FC642CFB44BE46A0F22E523",
                "groupproduct_namebrand": "Main Group", null
            },
           "community_name": "Community", {
                "nameproduct_family": "Admin Unit"null,
                "descriptionproduct": "admin unit"null,
                "idproduct_type": "1" null,
                 },"id": "F7D86F21653E417FB6C4D1AE665A0C41",
                "userproduct_brand": {
                    "personalternative_namecode": "CS"Eleni,
  3 Michailidou",                 "idname": "9A2CF58F91D94B8B981C33275BA20880Corso Shoes",
                    "emaildescription": "e_michailidou@crm.com",null,
                    "usernameid": "emichailidou5A917782ACA648B3BEAF417D1E64C43F"
            }    }
    },         "udf_string_2": null,},
         "udf_string_3": null,  {
      "udf_string_4": null,         "actualproduct_completion_datefamily": null,
                "udf_string_5product": null,
                "privacyproduct_leveltype": {
 null,         "users_set": [],         "udfmeter_stringreading_1type": null,
 
      "accounts_receivable": {             "numberservice_type": "ACR0000001957TERMED",
            "name": "ACR0000001957 Eleni Test Leads",    "used_for_provisioning": true,
       "id": "3FDD108E7CC74B0EB11ACC473A05E19F",             "lifealternative_cycle_statecode": "ACTIVEAS",
         
  "account_owner": {                 "companyudr_profiletype": null,
                    "companycomposition_namemethod": null,"FLAT",
                    "name": "Additional null,Services",
                    "last_namedescription": null,
  "Test Leads",                 "id": "7165977015D54B93B5FC9B3833C5A1FFC8321F0BCA8A4051857BC35CEEE41555",
                    "life_cycle_stateclassification": "FINANCIALSERVICES",
                    "middlephysical_good_nametype": null,
                "title": null},
                "typeid": "PERSON80160D5A245B4D0380A73D212E228131",
                "firstproduct_namebrand": "Eleni", null
            },
       "demographics": {    {
                "nameproduct_dayfamily": {null,
                        "month": null,"product": {
                    "code": "Abstract Physical Good",
   "day": null                "product_type": {
   },                     "idmeter_reading_numbertype": null,
                        "genderservice_type": null,
                        "countryused_offor_residenceprovisioning": {true,
                        "alternative_code": "CYPPhysical Good",
                        "threeudr_character_codetype": "CYP"null,
                        "namecomposition_method": "CYPRUSFLAT",
                        "idname": "181Physical Good",
                        "two_character_codedescription": "CY" null,
                         },"id": "5B6DAF4AD7C94C4D9C3B49950E10B256",
                        "date_of_birthclassification": {"PHYSICALGOODS",
                        "monthphysical_good_type": null,"TRACEABLE"
                        "year": null},
                    "alternative_code": "APG",
  "day": null                 "description": "Abstract Physical  }Good",
                    "industry_sectorid": null"754BEFEB2C324667A869808E1E7A350F",
                    "passportpriority_numberlevel": null,
                    "industry": null,
   },
                "socialproduct_security_numbertype": null,
   
                "id_issued_by_country": null,
   "A671AACDFC6145338241DB307EFCDF2C",
                "passport_issued_by_countryproduct_brand": null
   
            }
        ],
   }         }"udf_date_4": null,
        "contact_email": null,
        "lifeudf_cycle_state": "IN_PROGRESS"date_3": null,
        "number": "116",
        "udf_float_3": null,
        "priorityudf_float_4": 1null,
        "timeestimated_tocompletion_completiontime": {
            "time_period_uot": "WEEKS",
            "time_period_value": 1.57142857142857142
        },
        "leadprobability_productsto_setwin": [null,
        "id": "68B216C3A0E14173B48ED3FF4EB11182",
  {        "udf_float_1": null,
        "productudf_float_family2": null,
        "start_date": "2018-01-16T08:39:43",
        "productassigned_to": null,
   {
            "product_typeunit": {
   
                "meteralternative_reading_typecode": null,
   "adminunit",
                "servicegroup_typename": "TERMEDMain Group",
   
                "usedcommunity_for_provisioningname": true,
   "Community",
                "alternative_codename": "ASAdmin Unit",
   
                "udr_typedescription": "admin null,
   unit",
                "composition_methodid": "FLAT1",
            },
       "name": "Additional Services",   "user": {
                "descriptionperson_name": null,"Eleni 3   Michailidou",
                "id": "C8321F0BCA8A4051857BC35CEEE415559A2CF58F91D94B8B981C33275BA20880",
   
                "classificationemail": "SERVICESe_michailidou@crm.com",
                "username": "emichailidou"
   "physical_good_type": null        }
        },
        "udf_string_2": null,
        "idudf_string_3": "80160D5A245B4D0380A73D212E228131"null,
        "udf_string_4": null,
        "productactual_completion_branddate": null,
            }"udf_string_5": null,
        "privacy_level": null,
  {        "users_set": [],
        "productudf_string_family1": null,
        "accounts_receivable": {
      "product": {     "number": "ACR0000001957",
              "codename": "AbstractACR0000001957 Eleni PhysicalTest GoodLeads",
            "id": "3FDD108E7CC74B0EB11ACC473A05E19F",
            "productlife_cycle_typestate": { "ACTIVE",
            "account_owner": {
                "metercompany_reading_typeprofile": null,
       
                "servicecompany_typename": null,
       
                "used_for_provisioningname": true,
       null,
                "alternativelast_codename": "PhysicalTest GoodLeads",
       
                "udr_typeid": null,
       "7165977015D54B93B5FC9B3833C5A1FF",
                "compositionlife_cycle_methodstate": "FLATFINANCIAL",
       
                "middle_name": "Physical Good",
       null,
                "descriptiontitle": null,
       
                "idtype": "5B6DAF4AD7C94C4D9C3B49950E10B256",
       PERSON",
                "classificationfirst_name": "PHYSICALGOODSEleni",
                "demographics": {
      "physical_good_type": "TRACEABLE"                 "name_day": {
   },                     "alternative_codemonth": "APG"null,
                     "description": "Abstract Physical Good"day",: null
                   "id": "754BEFEB2C324667A869808E1E7A350F" },
                    "priorityid_levelnumber": null,
                    "gender": }null,
                    "productcountry_of_typeresidence": null, {
                        "idalternative_code": "A671AACDFC6145338241DB307EFCDF2CCYP",
 
              "product_brand": null             },
    "three_character_code": "CYP",
       {                 "product_familyname": null"CYPRUS",
                "product": null,          "id": "181",
      "product_type": null,                 "idtwo_character_code": "F7D86F21653E417FB6C4D1AE665A0C41CY",
                   "product_brand": { },
                    "alternativedate_of_codebirth": "CS", {
                        "namemonth": null,
  "Corso Shoes",                     "descriptionyear": null,
                        "idday": "5A917782ACA648B3BEAF417D1E64C43F" null
                    },
            },        "industry_sector": null,
   {                 "productpassport_familynumber": {null,
                    "codeindustry": "CH"null,
                    "namesocial_security_number": "Channels"null,
                    "descriptionid_issued_by_country": null,
                    "idpassport_issued_by_country": "5432773B865246E3B10A47CD130183C7"null
                },
                "product": null,}
         },
        "productlife_cycle_typestate": null,"IN_PROGRESS",
        "priority": 1,
        "idtime_to_completion": "91F6B5459FC642CFB44BE46A0F22E523",
   {
            "producttime_period_branduot": "WEEKS",
null             }"time_period_value": 1.1428571428571428
        ]},
        "lost_reason": null,
        "competitors_set": [
            {
                "competitor": {
                    "website": null,
                    "name": "Competitor 2MagnaQuest",
                    "description": null,
                    "id": "9A63A715C5174BD4B70FBE49EAC79815640A12797E964BFC99F8AF0EA538EEEA"
                },
                "id": "A0FF7979362946F98590D8964F06485F270455D963CA4059B93AEE4028D30A8E"
            },
            {
                "competitor": {
                    "website": "Zuora.com",
                    "name": "Zuora",
                    "description": null,
                    "id": "0CC8A3BDCA7B41B78058D0A178390B06"
                },
                "id": "9CC1CA44F25B4A7C962E032B58905DED"
            },
            {
                "competitor": {
                    "website": null,
                    "name": "MagnaQuestCompetitor 2",
                    "description": null,
                    "id": "640A12797E964BFC99F8AF0EA538EEEA9A63A715C5174BD4B70FBE49EAC79815"
                },
                "id": "270455D963CA4059B93AEE4028D30A8EA0FF7979362946F98590D8964F06485F"
            }
        ],
        "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": {
            "alternative_code": "INT",
            "name": "Interest",
            "description": null,
            "id": "C5C0EEDEC510465F963E1772E56A5B9C",
            "life_cycle_state": "IN_PROGRESS"
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}