Read Potential
Retrieves the details of a Potential object that has been previously created.
Parameters
Path Params | |
---|---|
yourCompany: | string |
Query Params | |
---|---|
filter: | string
|
Header Params | |
---|---|
key: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Code
{
"Potentials": {
"Potential": {
"PotentialId": "140605",
"PotentialName": "Potential No1",
"Amount": "10.000",
"AccountName": "Retail Sale1234",
"ExpectedCloseDate": "09-10-2026",
"Type": "--None--",
"NextStep": "Call before 15 days",
"LeadSource": "--None--",
"SalesStage": "Proposal/Price Quote",
"AssignedTo": "admin",
"Probability": "0.000",
"CreatedTime": "07-10-2021 20:38:10",
"CreatedTimeUTC": "07-10-2021 15:08:10",
"ModifiedTime": "23-10-2024 13:41:52",
"ModifiedTimeUTC": "23-10-2024 08:11:52",
"Description": "Description goes here",
"PotentialCustomFields": {
"CustomField": [
{
"Name": "Text",
"Value": "Customfield Text"
},
{
"Name": "Pick List",
"Value": "A"
},
{
"Name": "CheckBox",
"Value": "0"
},
{
"Name": "Date",
"Value": "00-00-0000"
}
]
}
},
"TotalRecords": "1",
"CurrentPage": "1",
"TotalPages": "1",
"PageSize": "50"
}
}
<Potentials>
<Potential>
<PotentialId>140605</PotentialId>
<PotentialName>Potential No1</PotentialName>
<Amount>10.000</Amount>
<AccountName>Retail Sale1234</AccountName>
<ExpectedCloseDate>09-10-2026</ExpectedCloseDate>
<Type>--None--</Type>
<NextStep>Call before 15 days</NextStep>
<LeadSource>--None--</LeadSource>
<SalesStage>Proposal/Price Quote</SalesStage>
<AssignedTo>admin</AssignedTo>
<Probability>0.000</Probability>
<CreatedTime>07-10-2021 20:38:10</CreatedTime>
<CreatedTimeUTC>07-10-2021 15:08:10</CreatedTimeUTC>
<ModifiedTime>23-10-2024 13:41:52</ModifiedTime>
<ModifiedTimeUTC>23-10-2024 08:11:52</ModifiedTimeUTC>
<Description>Description goes here</Description>
<PotentialCustomFields>
<CustomField>
<Name>Text</Name>
<Value>Customfield Text</Value>
</CustomField>
<CustomField>
<Name>Pick List</Name>
<Value>A</Value>
</CustomField>
<CustomField>
<Name>CheckBox</Name>
<Value>0</Value>
</CustomField>
<CustomField>
<Name>Date</Name>
<Value>00-00-0000</Value>
</CustomField>
</PotentialCustomFields>
</Potential>
<TotalRecords>1</TotalRecords>
<CurrentPage>1</CurrentPage>
<TotalPages>1</TotalPages>
<PageSize>50</PageSize>
</Potentials>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="Potential">
<method name="GET">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="Filter" type="xsd:string" style="query"/>
</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 about 21 hours ago