Read Contact
Retrieves the details of a Contact object that has been previously created.
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/Contact will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Contact |
| Query Params | |
|---|---|
| filter: | string In this parameter fieldname needs to be provided with condition and value to fetch related details.for eg. FirstName,eq,Contact firstname
List of condition abbrevations to be used: |
| customview: | string https://xyzcompany.agiliron.net/agiliron/api-40/Contact?customview=ABC Customview&key=xyzkey |
| page: | int https://xyzcompany.agiliron.net/agiliron/api-40/Contact?filter=FirstName,eq,Robert Smith;Test CheckBox,eq,no&page=10&key=xyzkey |
| pageSize: | int https://xyzcompany.agiliron.net/agiliron/api-40/Contact?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
{
"Contacts": {
"Contact": [{
"Salutation": "--None--",
"FirstName": "Test",
"LastName": "New Contact",
"OfficePhone": "56412356",
"Mobile": "7412536589",
"HomePhone": "56412356",
"OtherPhone": "",
"Fax": "5689746",
"AccountName": "Account1",
"AccountID": "234",
"VendorName": "Vendor1",
"VendorID": "30",
"ContactType": "Competitor",
"Title": "Test Title",
"Department": "Test Department",
"Email": "[email protected]",
"ReportsTo": "",
"ReportsToID": "",
"Assistant": "",
"YahooID": "[email protected]",
"AssistantPhone": "5989654",
"DoNotCall": "No",
"EmailOptOut": "No",
"AssignedToUser": "Administrator",
"LeadSource": "Self Generated",
"Birthday": "01-21-2020",
"ContactProfile": "Buyer",
"MailingStreet": "1515 Clay Street",
"MailingCity": "Oakland",
"MailingState": "CA",
"MailingZip": "94624",
"MailingCountry": "United States",
"OtherStreet": "1515 Clay Street",
"OtherCity": "Oakland",
"OtherState": "CA",
"OtherZip": "94624",
"OtherCountry": "United States",
"CreatedTime": "01-24-2020 05:32:01",
"CreatedTimeUTC": "01-24-2020 15:01:35",
"ModifiedTime": "01-24-2020 05:32:01",
"ModifiedTimeUTC": "01-24-2020 15:05:56",
"Description": "The Description Goes here.",
"B2BCustomer": "Yes",
"B2BChannels": "Ebay",
"CustomFields": {
"CustomField": [{
"Name": "CustomFied1",
"Value": "Custom info 1"
},
{
"Name": "CustomFied2",
"Value": "Custom info 2"
}
]
}
}]
}
}<Contacts>
<Contact>
<ContactId>156908</ContactId>
<Salutation>--None--</Salutation>
<FirstName>Test</FirstName>
<LastName>New Contact</LastName>
<OfficePhone>56412356</OfficePhone>
<Mobile>7412536589</Mobile>
<HomePhone>56412356</HomePhone>
<OtherPhone>
</OtherPhone>
<Fax>5689746</Fax>
<AccountName>Account1</AccountName>
<AccountID>234</AccountID>
<VendorName>Vendor1</VendorName>
<VendorID>30</VendorID>
<ContactType>Competitor</ContactType>
<Title>Test Title</Title>
<Department>Test Department</Department>
<Email>[email protected]</Email>
<ReportsTo>
</ReportsTo>
<ReportsToID>
</ReportsToID>
<Assistant>
</Assistant>
<YahooID>[email protected]</YahooID>
<AssistantPhone>5989654</AssistantPhone>
<DoNotCall>No</DoNotCall>
<EmailOptOut>No</EmailOptOut>
<AssignedToUser> Administrator</AssignedToUser>
<LeadSource>Self Generated</LeadSource>
<Birthday>01-21-2020</Birthday>
<ContactProfile>Buyer</ContactProfile>
<MailingStreet>1515 Clay Street</MailingStreet>
<MailingCity>Oakland</MailingCity>
<MailingState>CA</MailingState>
<MailingZip>94624</MailingZip>
<MailingCountry>United States</MailingCountry>
<OtherStreet>1515 Clay Street</OtherStreet>
<OtherCity>Oakland</OtherCity>
<OtherState>CA</OtherState>
<OtherZip>94624</OtherZip>
<OtherCountry>United States</OtherCountry>
<CreatedTime>01-24-2020 05:32:01</CreatedTime>
<CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
<ModifiedTime>01-24-2020 05:32:01</ModifiedTime>
<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
<Description>The Description Goes here.</Description>
<B2BCustomer>Yes</B2BCustomer>
<B2BChannels>Ebay</B2BChannels>
<CustomFields>
<CustomField>
<Name>CustomFied1</Name>
<Value>Custom info 1</Value>
</CustomField>
<CustomField>
<Name>CustomFied2</Name>
<Value>Custom info 2</Value>
</CustomField>
</CustomFields>
</Contact>
</Contacts>WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="Contact">
<method name="GET">
<resource path="{ContactID/ContactName/ContactEmail}">
<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>