Features - Connectors Framework - Inbound REST API - Prospects
List Prospects
Overview
Retrieve Prospect List of the client
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/prospect/list.html?token=XXXXXXXX&userId={userId}
Arguments
clientId
required
MobiWork assigned unique ID of the company
versionNumber
required
Version number of MobiWork API SDK release. Current version is: 10.0.78
token
required
Part of URL as a request parameter and is required in every call to verify access to API calls
userId
optional
If provided, this User ID will be taken as a logged in user
Filter or Search Criteria
firstName By first name of prospect
name By name of prospect
lastName By last name of prospect
Return
Returns a list of Prospect Object(s) if valid arguments and search criteria are provided. If no search criteria is provided the list of a maximum 200 prospects will be returned. Returns an error if not a valid request
Request Body XSD
Response Body XSD
Curl Example
HTTP Method: POST
Request: curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/prospect/list.html?token=COJL8X2FKSLMMRTYCH2B" --header 'content-type: application/xml' --data '<request><prospectType>RESIDENTIAL</prospectType><createdBy>Smith, John</createdBy></request>'
Response: <?xml encoding="UTF-8" ?>
<response version="10.0.78" statusCode="1">
<prospectList>
<totalAvailableCount>55</totalAvailableCount>
<count>55</count>
<prospect>
<entityId>1223587</entityId>
<name>Test Prospect</name>
<createdDate>09/17/2018 14:30:42</createdDate>
<prospectId>1223587</prospectId>
<firstName>Prospect First Name</firstName>
<lastName>Prospect Last Name</lastName>
<email>jdoe@gmail.com</email>
</prospect>