API ReferenceGuides
Guides
Home

Read Lead

Retrieves the details of a Lead object that has been previously created.

Suggest Edits

Parameters

Path Params
yourCompany:string
The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/Leads will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Leads
Query Params
filter:string
In this parameter fieldname needs to be provided with condition and value
to fetch related details.for eg. FirstName,eq,Lead firstname

1) To fetch Lead with firstname equal to Robert Smith and custom field(Test CheckBox) value is no or off, the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/Leads?filter=FirstName,eq,Robert Smith;Test CheckBox,eq,no&key=xyzkey

2) To fetch Lead with created date between 01-15-2020 to 01-31-2020 (Use | between two dates), the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/Leads?filter=CreatedTime,bt,01-15-2020 | 01-31-2020&key=xyzkey

3) To fetch Lead with created datetime between 01-15-2020 01:03:10 to 01-31-2020 20:00:00 (Use | between two dates), the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/Lead?filter=CreatedTime,bt,01-15-2020 01:03:10| 01-31-2020 20:00:00&key=xyzkey

4) To fetch Lead with Industry 'Apparel' OR 'Recreation' (Use OR between two values), the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/Lead?filter=Industry,eq,Apparel OR Recreation&key=xyzkey

5) To fetch Lead with LeadId equal to 3422, the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/Lead?filter=LeadId,eq,3422&key=xyzkey

List of condition abbrevations to be used:
"cs": contain string (string contains value)
"sw": start with (string starts with value)
"ew": end with (string end with value)
"neq": not equal (string or number should not match)
"eq": equal (string or number matches exactly)
"lt": lower than (number is lower than value)
"le": lower or equal (number is lower than or equal to value)
"ge": greater or equal (number is higher than or equal to value)
"gt": greater than (number is higher than value)
"bt": between (number is between two comma separated values)
customview:string
In this parameter customview name needs to be provided to fetch related details.For eg. To fetch Leads customview with name as ABC Customview, the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/Lead?customview=ABC Customview&key=xyzkey
page:int
Page number needs to be passed in this variable ,to paginate the response.For eg. To fetch Lead with firstname equal to Robert Smith and custom field(Test CheckBox) value is no or off and page equal to 10, the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/Leads?filter=FirstName,eq,Robert Smith;Test CheckBox,eq,no&page=10&key=xyzkey
pageSize:int
In this parameter pageSize number needs to be provided to fetch related page details.For eg. To fetch Lead with firstname equal to Robert Smith and custom field(Test CheckBox) value is no or off and page size equal to 10, the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/Leads?filter=FirstName,eq,Robert Smith;Test CheckBox,eq,no&pageSize=10&key=xyzkey
Header Params
Accept:string
Response header need to be passed for eg. application/json or application/xml.
Query Auth
key:string
API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.
Header Auth
apiKey:string
Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

Sample Response 

{
	"Leads": {
		"Lead": [{
			"Salutation": "--None--",
			"FirstName": "Test",
			"LastName": "New Lead",
			"Company": "Test Company",
			"Designation": "Test Title",
			"Phone": "56412356",
			"Mobile": "7412536589",
			"Fax": "5689746",
			"Email": "[email protected]",
			"Website": "",
			"Industry": "Recreation",
			"SICCode": "10",
			"AnnualRevenue": "65",
			"NumberOfEmployees": "25",
			"ContactType": "Customer",
			"LeadSource": "Self Generated",
			"LeadStatus": "Contacted",
			"Rating": "Acquired",
			"EmailOptOut": "No",
			"YahooID": "[email protected]",
			"CreatedTime": "01-24-2020 05:01:35",
			"CreatedTimeUTC": "01-24-2020 15:01:35",
			"ModifiedTime": "01-24-2020 05:05:56",
			"ModifiedTimeUTC": "01-24-2020 15:05:56",
			"Street": "1515 Clay Street",
			"City": "Oakland",
			"State": "CA",
			"Zip": "94624",
			"Country": "United States",
			"Description": "The Description Goes here.",
			"AssignedTo": "admin",
			"AssignedGroupName": "",
			"DefaultCurrency": "USD",
			"LeadCustomFields": {
				"CustomField": [{
						"Name": "CustomFied1",
						"Value": "Custom info 1"
					},
					{
						"Name": "CustomFied2",
						"Value": "Custom info 2"
					}
				]
			}
		}]
	}
}

<Leads>
   <Lead>
      <Salutation>--None--</Salutation>
      <FirstName>Test</FirstName>
      <LastName>New Lead</LastName>
      <Company>Test Company</Company>
      <Designation>Test Title</Designation>
      <Phone>56412356</Phone>
      <Mobile>7412536589</Mobile>
      <Fax>5689746</Fax>
      <Email>[email protected]</Email>
      <Website />
      <Industry>Recreation</Industry>
      <SICCode>10</SICCode>
      <AnnualRevenue>65</AnnualRevenue>
      <NumberOfEmployees>25</NumberOfEmployees>
      <ContactType>Customer</ContactType>
      <LeadSource>Self Generated</LeadSource>
      <LeadStatus>Contacted</LeadStatus>
      <Rating>Acquired</Rating>
      <EmailOptOut>No</EmailOptOut>
      <YahooID>[email protected]</YahooID>
      <CreatedTime>01-24-2020 05:01:35</CreatedTime>
      <CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
      <ModifiedTime>01-24-2020 05:05:56</ModifiedTime>
      <ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
      <Street>1515 Clay Street</Street>
      <City>Oakland</City>
      <State>CA</State>
      <Zip>94624</Zip>
      <Country>United States</Country>
      <Description>The Description Goes here.</Description>
      <AssignedTo>admin</AssignedTo>
      <AssignedGroupName></AssignedGroupName>
      <DefaultCurrency>USD</DefaultCurrency>
      <LeadCustomFields>
         <CustomField>
            <Name>CustomFied1</Name>
            <Value>Custom info 1</Value>
         </CustomField>
         <CustomField>
            <Name>CustomFied2</Name>
            <Value>Custom info 2</Value>
         </CustomField>
      </LeadCustomFields>
   </Lead>
</Leads>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="Leads"> 
       <method name="GET">
	   <resource path="{LeadEmail}">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
         </request> 
         <response status="200"> 
            <representation mediaType="application/xml" element="yn:ResultSet"/> 
         </response> 
         <response status="400"> 
            <representation mediaType="application/xml" element="ya:Error"/> 
         </response> 
       </method> 
     </resource> 
   </resources>
 </application>

Updated over 1 year ago

© Copyright 2022 Agiliron - All Rights Reserved.