URL

https://devwebapi.leadmaster.com/api/Automation/SearchOpportunity

Description

Searches the opportunity.

HttpMethod

POST

Request Information

Parameters

NameDescriptionAdditional information
request
The request.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "access_token": "sample string 1",
  "FieldName": "sample string 2",
  "FieldValue": "sample string 3"
}

application/xml, text/xml

Sample:
<SearchRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessObjects.ViewModel">
  <FieldName>sample string 2</FieldName>
  <FieldValue>sample string 3</FieldValue>
  <access_token>sample string 1</access_token>
</SearchRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "StatusCode": 100,
  "IsSuccess": true,
  "Message": "sample string 2",
  "Result": {
    "CompanyName": "sample string 1",
    "Address1": "sample string 2",
    "Address2": "sample string 3",
    "Address3": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "Zip": "sample string 7",
    "Country": "sample string 8",
    "Email": "sample string 9",
    "FirstName": "sample string 10",
    "LastName": "sample string 11",
    "RecordID": 12,
    "RECDNO": 13,
    "OppName": "sample string 14",
    "OppDesc": "sample string 15",
    "SalesStatus": "sample string 16",
    "ForecastDate": "2025-04-25T07:18:13.762905-04:00",
    "WinProbability": 17.1,
    "NumOfHourWork": 18.1,
    "NumOfHourTravel": 19.1,
    "OppSource": "sample string 20",
    "CloseDate": "2025-04-25T07:18:13.762905-04:00",
    "SalesStage": "sample string 21",
    "CloseReason": "sample string 22",
    "Custom0": "sample string 23",
    "Custom1": "sample string 24",
    "Custom2": "sample string 25",
    "Custom3": "sample string 26",
    "Custom4": "sample string 27",
    "OppNote": "sample string 28",
    "OppTotal": 29.0,
    "TotalQuantity": 30,
    "ContactID": 31,
    "DateCreated": "2025-04-25T07:18:13.762905-04:00",
    "LastUpdated": "2025-04-25T07:18:13.762905-04:00",
    "Edited": "2025-04-25T07:18:13.762905-04:00",
    "UpdatedBy": "sample string 32",
    "OppType": "sample string 33",
    "Custom5": 34.0,
    "Custom6": "2025-04-25T07:18:13.762905-04:00",
    "Custom7": 35.0,
    "otherRECDNO": 36.0,
    "Reassign": 37,
    "User_Field_1": "sample string 38",
    "User_Field_2": "sample string 39",
    "User_Field_3": "sample string 40",
    "User_Field_4": "sample string 41",
    "User_Field_5": "sample string 42",
    "User_Field_6": "sample string 43",
    "User_Field_7": "sample string 44",
    "User_Field_8": "sample string 45",
    "dUser_Field_1": "2025-04-25T07:18:13.762905-04:00",
    "dUser_Field_2": "2025-04-25T07:18:13.762905-04:00",
    "dUser_Field_3": "2025-04-25T07:18:13.762905-04:00",
    "dUser_Field_4": "2025-04-25T07:18:13.762905-04:00",
    "dUser_Field_5": "2025-04-25T07:18:13.762905-04:00",
    "dUser_Field_6": "2025-04-25T07:18:13.762905-04:00",
    "dUser_Field_7": "2025-04-25T07:18:13.762905-04:00",
    "dUser_Field_8": "2025-04-25T07:18:13.762905-04:00",
    "dUser_Field_9": "2025-04-25T07:18:13.762905-04:00",
    "dUser_Field_10": "2025-04-25T07:18:13.762905-04:00",
    "iUser_Field_1": 46,
    "iUser_Field_2": 47,
    "iUser_Field_3": 48,
    "iUser_Field_4": 49,
    "iUser_Field_5": 50,
    "iUser_Field_6": 51,
    "iUser_Field_7": 52,
    "iUser_Field_8": 53,
    "iUser_Field_9": 54,
    "iUser_Field_10": 55,
    "QBInvoiceId": 56,
    "ImportKey": "sample string 57",
    "User_Field_9": "sample string 58",
    "Discount": "sample string 59",
    "OppContactsID2": 60,
    "referralRECDNO": 61,
    "referralContactID": 62,
    "referralOppID": 63,
    "OppReferralName": "sample string 64"
  }
}

application/xml, text/xml

Sample:
<APIResponseBaseOfGetOpportunityProperties6ZPUqztj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessObjects.ViewModel">
  <IsSuccess>true</IsSuccess>
  <Message>sample string 2</Message>
  <Result>
    <CloseDate>2025-04-25T07:18:13.762905-04:00</CloseDate>
    <CloseReason>sample string 22</CloseReason>
    <ContactID>31</ContactID>
    <Custom0>sample string 23</Custom0>
    <Custom1>sample string 24</Custom1>
    <Custom2>sample string 25</Custom2>
    <Custom3>sample string 26</Custom3>
    <Custom4>sample string 27</Custom4>
    <Custom5>34</Custom5>
    <Custom6>2025-04-25T07:18:13.762905-04:00</Custom6>
    <Custom7>35</Custom7>
    <DateCreated>2025-04-25T07:18:13.762905-04:00</DateCreated>
    <Discount>sample string 59</Discount>
    <Edited>2025-04-25T07:18:13.762905-04:00</Edited>
    <ForecastDate>2025-04-25T07:18:13.762905-04:00</ForecastDate>
    <ImportKey>sample string 57</ImportKey>
    <LastUpdated>2025-04-25T07:18:13.762905-04:00</LastUpdated>
    <NumOfHourTravel>19.1</NumOfHourTravel>
    <NumOfHourWork>18.1</NumOfHourWork>
    <OppContactsID2>60</OppContactsID2>
    <OppDesc>sample string 15</OppDesc>
    <OppName>sample string 14</OppName>
    <OppNote>sample string 28</OppNote>
    <OppReferralName>sample string 64</OppReferralName>
    <OppSource>sample string 20</OppSource>
    <OppTotal>29</OppTotal>
    <OppType>sample string 33</OppType>
    <QBInvoiceId>56</QBInvoiceId>
    <RECDNO>13</RECDNO>
    <Reassign>37</Reassign>
    <RecordID>12</RecordID>
    <SalesStage>sample string 21</SalesStage>
    <SalesStatus>sample string 16</SalesStatus>
    <TotalQuantity>30</TotalQuantity>
    <UpdatedBy>sample string 32</UpdatedBy>
    <User_Field_1>sample string 38</User_Field_1>
    <User_Field_2>sample string 39</User_Field_2>
    <User_Field_3>sample string 40</User_Field_3>
    <User_Field_4>sample string 41</User_Field_4>
    <User_Field_5>sample string 42</User_Field_5>
    <User_Field_6>sample string 43</User_Field_6>
    <User_Field_7>sample string 44</User_Field_7>
    <User_Field_8>sample string 45</User_Field_8>
    <User_Field_9>sample string 58</User_Field_9>
    <WinProbability>17.1</WinProbability>
    <dUser_Field_1>2025-04-25T07:18:13.762905-04:00</dUser_Field_1>
    <dUser_Field_10>2025-04-25T07:18:13.762905-04:00</dUser_Field_10>
    <dUser_Field_2>2025-04-25T07:18:13.762905-04:00</dUser_Field_2>
    <dUser_Field_3>2025-04-25T07:18:13.762905-04:00</dUser_Field_3>
    <dUser_Field_4>2025-04-25T07:18:13.762905-04:00</dUser_Field_4>
    <dUser_Field_5>2025-04-25T07:18:13.762905-04:00</dUser_Field_5>
    <dUser_Field_6>2025-04-25T07:18:13.762905-04:00</dUser_Field_6>
    <dUser_Field_7>2025-04-25T07:18:13.762905-04:00</dUser_Field_7>
    <dUser_Field_8>2025-04-25T07:18:13.762905-04:00</dUser_Field_8>
    <dUser_Field_9>2025-04-25T07:18:13.762905-04:00</dUser_Field_9>
    <iUser_Field_1>46</iUser_Field_1>
    <iUser_Field_10>55</iUser_Field_10>
    <iUser_Field_2>47</iUser_Field_2>
    <iUser_Field_3>48</iUser_Field_3>
    <iUser_Field_4>49</iUser_Field_4>
    <iUser_Field_5>50</iUser_Field_5>
    <iUser_Field_6>51</iUser_Field_6>
    <iUser_Field_7>52</iUser_Field_7>
    <iUser_Field_8>53</iUser_Field_8>
    <iUser_Field_9>54</iUser_Field_9>
    <otherRECDNO>36</otherRECDNO>
    <referralContactID>62</referralContactID>
    <referralOppID>63</referralOppID>
    <referralRECDNO>61</referralRECDNO>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <Address3>sample string 4</Address3>
    <City>sample string 5</City>
    <CompanyName>sample string 1</CompanyName>
    <Country>sample string 8</Country>
    <Email>sample string 9</Email>
    <FirstName>sample string 10</FirstName>
    <LastName>sample string 11</LastName>
    <State>sample string 6</State>
    <Zip>sample string 7</Zip>
  </Result>
  <StatusCode>Continue</StatusCode>
</APIResponseBaseOfGetOpportunityProperties6ZPUqztj>