Get a Contact by Reference ID
curl --request GET \
--url https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 100234,
"contactType": "Household",
"isPrivate": false,
"name": "Marcus Castellano",
"informalName": "Marcus & Elena Castellano",
"description": "Household led by Marcus Castellano; board member and major donor.",
"website": null,
"maritalStatus": "Married",
"anniversaryMonth": null,
"anniversaryDay": null,
"anniversaryYear": null,
"giftAskAmount": "1000.00",
"giftAskType": "Capital Campaign",
"lifeToDateGiving": "42500.00",
"yearToDateGiving": "4000.00",
"lastGiftAmount": "1000.00",
"lastGiftDate": "2025-10-12T00:00:00Z",
"contactIndividuals": [
{
"id": 200234,
"prefix": "Mr.",
"firstName": "Marcus",
"middleName": "David",
"lastName": "Castellano",
"suffix": null,
"gender": "Male",
"isPrimary": true,
"isSecondary": false,
"birthMonth": 3,
"birthDay": 18,
"birthYear": 1972,
"birthDate": "1972-03-18T00:00:00Z",
"approximateAge": 53,
"isDeceased": false,
"passion": "Youth education",
"contactMethods": [
{
"id": 300101,
"type": "Home Email",
"value": "marcus.castellano@example.org",
"isOptedIn": true,
"isPrimary": true,
"isArchived": false
},
{
"id": 300102,
"type": "Mobile Phone",
"value": "(555) 012-3401",
"isOptedIn": true,
"isPrimary": true,
"isArchived": false
}
]
},
{
"id": 200235,
"prefix": "Mrs.",
"firstName": "Elena",
"middleName": "Maria",
"lastName": "Castellano",
"suffix": null,
"gender": "Female",
"isPrimary": false,
"isSecondary": true,
"birthMonth": 8,
"birthDay": 22,
"birthYear": 1974,
"birthDate": "1974-08-22T00:00:00Z",
"approximateAge": 51,
"isDeceased": false,
"passion": "Community health",
"contactMethods": [
{
"id": 300104,
"type": "Home Email",
"value": "elena.castellano@example.org",
"isOptedIn": true,
"isPrimary": true,
"isArchived": false
},
{
"id": 300105,
"type": "Mobile Phone",
"value": "(555) 012-3402",
"isOptedIn": true,
"isPrimary": true,
"isArchived": false
}
]
}
],
"address": {
"id": 400123,
"label": "Home",
"address1": "219 Oak Hill Drive",
"address2": null,
"city": "Springfield",
"state": "OR",
"postal": "97478",
"country": "United States",
"isPrimary": true,
"startMonth": null,
"startDay": null,
"endMonth": null,
"endDay": null
}
}{
"message": "Authorization has been denied for this request."
}{
"message": "Rate limit exceeded. Try again later."
}Contacts and Individuals
Get a Contact by Reference ID
Returns the contact carrying the given reference id from an external system, without needing to know the reference source. HMAC Auth only.
GET
/
api
/
Contact
/
ByReference
/
{referenceId}
Get a Contact by Reference ID
curl --request GET \
--url https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/Contact/ByReference/{referenceId}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 100234,
"contactType": "Household",
"isPrivate": false,
"name": "Marcus Castellano",
"informalName": "Marcus & Elena Castellano",
"description": "Household led by Marcus Castellano; board member and major donor.",
"website": null,
"maritalStatus": "Married",
"anniversaryMonth": null,
"anniversaryDay": null,
"anniversaryYear": null,
"giftAskAmount": "1000.00",
"giftAskType": "Capital Campaign",
"lifeToDateGiving": "42500.00",
"yearToDateGiving": "4000.00",
"lastGiftAmount": "1000.00",
"lastGiftDate": "2025-10-12T00:00:00Z",
"contactIndividuals": [
{
"id": 200234,
"prefix": "Mr.",
"firstName": "Marcus",
"middleName": "David",
"lastName": "Castellano",
"suffix": null,
"gender": "Male",
"isPrimary": true,
"isSecondary": false,
"birthMonth": 3,
"birthDay": 18,
"birthYear": 1972,
"birthDate": "1972-03-18T00:00:00Z",
"approximateAge": 53,
"isDeceased": false,
"passion": "Youth education",
"contactMethods": [
{
"id": 300101,
"type": "Home Email",
"value": "marcus.castellano@example.org",
"isOptedIn": true,
"isPrimary": true,
"isArchived": false
},
{
"id": 300102,
"type": "Mobile Phone",
"value": "(555) 012-3401",
"isOptedIn": true,
"isPrimary": true,
"isArchived": false
}
]
},
{
"id": 200235,
"prefix": "Mrs.",
"firstName": "Elena",
"middleName": "Maria",
"lastName": "Castellano",
"suffix": null,
"gender": "Female",
"isPrimary": false,
"isSecondary": true,
"birthMonth": 8,
"birthDay": 22,
"birthYear": 1974,
"birthDate": "1974-08-22T00:00:00Z",
"approximateAge": 51,
"isDeceased": false,
"passion": "Community health",
"contactMethods": [
{
"id": 300104,
"type": "Home Email",
"value": "elena.castellano@example.org",
"isOptedIn": true,
"isPrimary": true,
"isArchived": false
},
{
"id": 300105,
"type": "Mobile Phone",
"value": "(555) 012-3402",
"isOptedIn": true,
"isPrimary": true,
"isArchived": false
}
]
}
],
"address": {
"id": 400123,
"label": "Home",
"address1": "219 Oak Hill Drive",
"address2": null,
"city": "Springfield",
"state": "OR",
"postal": "97478",
"country": "United States",
"isPrimary": true,
"startMonth": null,
"startDay": null,
"endMonth": null,
"endDay": null
}
}{
"message": "Authorization has been denied for this request."
}{
"message": "Rate limit exceeded. Try again later."
}Authorizations
Response
OK
Was this page helpful?