3.0
API change historyREST API with full access to Enquire Objects and meta-data for CRUD operations.
Request
Request URL
Request parameters
-
number
This is the Id of the individual you would like to retrieve
-
number
This is your company Id. You can request this value from EnquireLEADS support when registering for the API.
Request headers
Request body
Responses
200 OK
Properties are custom and different based on each Portal and Individual Type. You can find all properties available using the Object GET method.
Representations
{
"result":{
"individuals":[
{
"casenumber":"GD100001",
"individualid":"193478",
"created":"2014-07-29T16:29:50.6746326",
"createdby":"Enquire Support",
"type":"Prospect",
"community":{
"Id":"73",
"Name":"Community 1",
"NameUnique":"Community1"
},
"properties":[
{
"id":"5444",
"label":"Salutation",
"value":"Mr."
},
{
"id":"5469",
"label":"First Name",
"value":"Conrad"
},
{
"id":"5494",
"label":"Middle Name",
"value":"Mathew"
},
{
"id":"5519",
"label":"Last Name",
"value":"Tate"
},
{
"id":"5544",
"label":"Home Phone",
"value":"1234567890"
},
{
"id":"5569",
"label":"Mobile Phone",
"value":"0987654321"
},
{
"id":"5594",
"label":"Work Phone",
"value":"5555555555"
},
{
"id":"5619",
"label":"Fax",
"value":"9999999999"
},
{
"id":"5644",
"label":"Email",
"value":"MT@mailinator.com"
},
{
"id":"5694",
"label":"Website",
"value":"hissite.com"
},
{
"id":"5869",
"label":"Mailing List",
"value":"1"
},
{
"id":"5894",
"label":"Birthdate",
"value":"1938-02-23 00:00:00.0000000"
},
{
"id":"5919",
"label":"Gender",
"value":"Male"
},
{
"id":"5944",
"label":"Marital Status",
"value":"Widowed"
},
{
"id":"5969",
"label":"Religion"
},
{
"id":"5994",
"label":"Language",
"value":"English"
},
{
"id":"6019",
"label":"Ethnicity",
"value":"White"
},
{
"id":"6044",
"label":"Veteran (Y/N)",
"value":"1"
},
{
"id":"9389",
"label":"Ok to",
"value":"Email, Mail, Call"
},
{
"id":"7265",
"label":"Postal Code",
"Value":null
},
{
"id":"7421",
"label":"State",
"Value":null
},
{
"id":"7551",
"label":"Has Address",
"Value":null
},
{
"id":"7577",
"label":"Has Email",
"Value":null
},
{
"id":"7603",
"label":"Has Phone",
"Value":null
},
{
"id":"7291",
"label":"Contact of Resident",
"Value":null
},
{
"id":"7317",
"label":"Contact of Prospect",
"Value":null
},
{
"id":"7343",
"label":"Have Deposited",
"Value":null
},
{
"id":"7369",
"label":"Have Toured",
"Value":null
},
{
"id":"7395",
"label":"Type",
"Value":null
},
{
"id":"7447",
"label":"Assigned User",
"Value":null
},
{
"id":"7499",
"label":"Status",
"Value":null
},
{
"id":"7525",
"label":"Primary Contact",
"Value":null
},
{
"id":"7629",
"label":"Created On",
"Value":null
},
{
"id":"7655",
"label":"Activity On",
"Value":null
},
{
"id":"7681",
"label":"Tour On",
"Value":null
},
{
"id":"7707",
"label":"Deposit On",
"Value":null
},
{
"id":"7733",
"label":"Created By",
"Value":null
},
{
"id":"9406",
"label":"Relationship Type",
"Value":null
},
{
"id":"9444",
"label":"Has No Primary Contact",
"Value":null
},
{
"id":"8170",
"label":"Lead Score",
"Value":null
},
{
"id":"8171",
"label":"Digital Score",
"Value":null
},
{
"id":"8172",
"label":"Annual Income",
"Value":null
},
{
"id":"8173",
"label":"Age Code",
"Value":null
},
{
"id":"8174",
"label":"Home Value",
"Value":null
},
{
"id":"8175",
"label":"Net Worth",
"Value":null
},
{
"id":"8176",
"label":"Financially Qualified",
"Value":null
},
{
"id":"8177",
"label":"Floor Preference",
"Value":null
},
{
"id":"8178",
"label":"Lead Engagement",
"Value":null
},
{
"id":"8179",
"label":"Lead Fit",
"Value":null
},
{
"id":"8180",
"label":"Status Code",
"value":"1- Future Lead"
},
{
"id":"8181",
"label":"Lost Lead"
},
{
"id":"8182",
"label":"Market Source",
"value":"Direct Mail"
},
{
"id":"8183",
"label":"Care Level",
"value":"Assisted Living"
},
{
"id":"8591",
"label":"Act-On Opt-Out",
"value":"No"
},
{
"id":"8592",
"label":"Act-On Bounce",
"value":"No"
},
{
"id":"10091",
"label":"Priority Date"
},
{
"id":"9334",
"label":"First Name",
"Value":null
},
{
"id":"9335",
"label":"Last Name",
"Value":null
},
{
"id":"9337",
"label":"Prefix",
"Value":null
},
{
"id":"9338",
"label":"Gender",
"Value":null
}
]
}
]
}
}
400 Bad Request
IndividualId is required
Code samples
@ECHO OFF
curl -v -X GET "https://api2.enquiresolutions.com/v3/Individual/{Id}?PortalId={number}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["PortalId"] = "{number}";
var uri = "https://api2.enquiresolutions.com/v3/Individual/{Id}?" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api2.enquiresolutions.com/v3/Individual/{Id}");
builder.setParameter("PortalId", "{number}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"PortalId": "{number}",
};
$.ajax({
url: "https://api2.enquiresolutions.com/v3/Individual/{Id}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api2.enquiresolutions.com/v3/Individual/{Id}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"PortalId={number}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api2.enquiresolutions.com/v3/Individual/{Id}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'PortalId' => '{number}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'PortalId': '{number}',
})
try:
conn = httplib.HTTPSConnection('api2.enquiresolutions.com')
conn.request("GET", "/v3/Individual/{Id}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'PortalId': '{number}',
})
try:
conn = http.client.HTTPSConnection('api2.enquiresolutions.com')
conn.request("GET", "/v3/Individual/{Id}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://api2.enquiresolutions.com/v3/Individual/{Id}')
query = URI.encode_www_form({
# Request parameters
'PortalId' => '{number}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body