API ReferenceGuides
Guides
Home

Read Potential

Retrieves the details of a Potential 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/Potential will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Potential
Query Params
filter:string
In this parameter fieldname needs to be provided with condition and value
to fetch related details.for eg. PotentialSubject,eq,Subject

  1. To fetch Potential with subject equal to New Potential, the following url must be used**<https://xyzcompany.agiliron.net/agiliron/api-40/Potential?filter=Subject,eq,New PotentialSubject>

  2. To fetch Potential with created date between 01-15-2020 to 01-31-2020 (Use | between two dates), the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/Potential?filter=CreatedTime,bt,01-15-2020 | 01-31-2020&key=xyzkey

  3. To fetch Potential 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 usedhttps://xyzcompany.agiliron.net/agiliron/api-40/Potential?filter=CreatedTime,bt,01-15-2020 01:03:10| 01-31-2020 20:00:00&key=xyzkey

  4. To fetch Potential with PotentialId equal to 3422, the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/Potential?filter=PotentialId,eq,3422&key=xyzkeyList 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)

Header Params
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.
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 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>
© Copyright 2022 Agiliron - All Rights Reserved.