Query Contact References
curl --request POST \
--url https://api.virtuoussoftware.com/api/ContactReference/Query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"groups": [
{
"conjunct": "And",
"conditions": [
{
"parameter": "Contact Id",
"operator": "Is",
"value": "501"
},
{
"parameter": "Reference Source",
"operator": "Is",
"value": "Stripe"
},
{
"parameter": "Reference Id",
"operator": "Is",
"value": "cus_123456"
}
]
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
groups: [
{
conjunct: 'And',
conditions: [
{parameter: 'Contact Id', operator: 'Is', value: '501'},
{parameter: 'Reference Source', operator: 'Is', value: 'Stripe'},
{parameter: 'Reference Id', operator: 'Is', value: 'cus_123456'}
]
}
]
})
};
fetch('https://api.virtuoussoftware.com/api/ContactReference/Query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/ContactReference/Query"
payload = { "groups": [
{
"conjunct": "And",
"conditions": [
{
"parameter": "Contact Id",
"operator": "Is",
"value": "501"
},
{
"parameter": "Reference Source",
"operator": "Is",
"value": "Stripe"
},
{
"parameter": "Reference Id",
"operator": "Is",
"value": "cus_123456"
}
]
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/ContactReference/Query");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"groups\": [\n {\n \"conjunct\": \"And\",\n \"conditions\": [\n {\n \"parameter\": \"Contact Id\",\n \"operator\": \"Is\",\n \"value\": \"501\"\n },\n {\n \"parameter\": \"Reference Source\",\n \"operator\": \"Is\",\n \"value\": \"Stripe\"\n },\n {\n \"parameter\": \"Reference Id\",\n \"operator\": \"Is\",\n \"value\": \"cus_123456\"\n }\n ]\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/ContactReference/Query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'groups' => [
[
'conjunct' => 'And',
'conditions' => [
[
'parameter' => 'Contact Id',
'operator' => 'Is',
'value' => '501'
],
[
'parameter' => 'Reference Source',
'operator' => 'Is',
'value' => 'Stripe'
],
[
'parameter' => 'Reference Id',
'operator' => 'Is',
'value' => 'cus_123456'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.virtuoussoftware.com/api/ContactReference/Query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"groups\": [\n {\n \"conjunct\": \"And\",\n \"conditions\": [\n {\n \"parameter\": \"Contact Id\",\n \"operator\": \"Is\",\n \"value\": \"501\"\n },\n {\n \"parameter\": \"Reference Source\",\n \"operator\": \"Is\",\n \"value\": \"Stripe\"\n },\n {\n \"parameter\": \"Reference Id\",\n \"operator\": \"Is\",\n \"value\": \"cus_123456\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/ContactReference/Query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"groups\": [\n {\n \"conjunct\": \"And\",\n \"conditions\": [\n {\n \"parameter\": \"Contact Id\",\n \"operator\": \"Is\",\n \"value\": \"501\"\n },\n {\n \"parameter\": \"Reference Source\",\n \"operator\": \"Is\",\n \"value\": \"Stripe\"\n },\n {\n \"parameter\": \"Reference Id\",\n \"operator\": \"Is\",\n \"value\": \"cus_123456\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/ContactReference/Query';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
groups: [
{
conjunct: 'And',
conditions: [
{parameter: 'Contact Id', operator: 'Is', value: '501'},
{parameter: 'Reference Source', operator: 'Is', value: 'Stripe'},
{parameter: 'Reference Id', operator: 'Is', value: 'cus_123456'}
]
}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"list": [
{
"id": 25,
"contactId": 501,
"contactIndividualId": null,
"referenceSource": "Stripe",
"referenceId": "cus_123456",
"createdDateTimeUtc": "2026-09-30T14:22:00Z",
"modifiedDateTimeUtc": "2026-09-30T14:22:00Z"
}
],
"total": 1
}{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Contacts and Individuals
Query Contact References
Returns a paginated list of Contact References visible to the current user. Use Get Contact Reference Query Options to see supported filters and operators. Conditions in each group are combined with AND; groups are combined with OR. Id can be sorted but is not a filter. Sort by Id, Contact Id, Create DateTime UTC, or Last Modified DateTime UTC; an unsupported sortBy value falls back to Id. Archived contacts are excluded from results.
POST
/
api
/
ContactReference
/
Query
Query Contact References
curl --request POST \
--url https://api.virtuoussoftware.com/api/ContactReference/Query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"groups": [
{
"conjunct": "And",
"conditions": [
{
"parameter": "Contact Id",
"operator": "Is",
"value": "501"
},
{
"parameter": "Reference Source",
"operator": "Is",
"value": "Stripe"
},
{
"parameter": "Reference Id",
"operator": "Is",
"value": "cus_123456"
}
]
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
groups: [
{
conjunct: 'And',
conditions: [
{parameter: 'Contact Id', operator: 'Is', value: '501'},
{parameter: 'Reference Source', operator: 'Is', value: 'Stripe'},
{parameter: 'Reference Id', operator: 'Is', value: 'cus_123456'}
]
}
]
})
};
fetch('https://api.virtuoussoftware.com/api/ContactReference/Query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/ContactReference/Query"
payload = { "groups": [
{
"conjunct": "And",
"conditions": [
{
"parameter": "Contact Id",
"operator": "Is",
"value": "501"
},
{
"parameter": "Reference Source",
"operator": "Is",
"value": "Stripe"
},
{
"parameter": "Reference Id",
"operator": "Is",
"value": "cus_123456"
}
]
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/ContactReference/Query");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"groups\": [\n {\n \"conjunct\": \"And\",\n \"conditions\": [\n {\n \"parameter\": \"Contact Id\",\n \"operator\": \"Is\",\n \"value\": \"501\"\n },\n {\n \"parameter\": \"Reference Source\",\n \"operator\": \"Is\",\n \"value\": \"Stripe\"\n },\n {\n \"parameter\": \"Reference Id\",\n \"operator\": \"Is\",\n \"value\": \"cus_123456\"\n }\n ]\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/ContactReference/Query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'groups' => [
[
'conjunct' => 'And',
'conditions' => [
[
'parameter' => 'Contact Id',
'operator' => 'Is',
'value' => '501'
],
[
'parameter' => 'Reference Source',
'operator' => 'Is',
'value' => 'Stripe'
],
[
'parameter' => 'Reference Id',
'operator' => 'Is',
'value' => 'cus_123456'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.virtuoussoftware.com/api/ContactReference/Query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"groups\": [\n {\n \"conjunct\": \"And\",\n \"conditions\": [\n {\n \"parameter\": \"Contact Id\",\n \"operator\": \"Is\",\n \"value\": \"501\"\n },\n {\n \"parameter\": \"Reference Source\",\n \"operator\": \"Is\",\n \"value\": \"Stripe\"\n },\n {\n \"parameter\": \"Reference Id\",\n \"operator\": \"Is\",\n \"value\": \"cus_123456\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/ContactReference/Query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"groups\": [\n {\n \"conjunct\": \"And\",\n \"conditions\": [\n {\n \"parameter\": \"Contact Id\",\n \"operator\": \"Is\",\n \"value\": \"501\"\n },\n {\n \"parameter\": \"Reference Source\",\n \"operator\": \"Is\",\n \"value\": \"Stripe\"\n },\n {\n \"parameter\": \"Reference Id\",\n \"operator\": \"Is\",\n \"value\": \"cus_123456\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/ContactReference/Query';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
groups: [
{
conjunct: 'And',
conditions: [
{parameter: 'Contact Id', operator: 'Is', value: '501'},
{parameter: 'Reference Source', operator: 'Is', value: 'Stripe'},
{parameter: 'Reference Id', operator: 'Is', value: 'cus_123456'}
]
}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"list": [
{
"id": 25,
"contactId": 501,
"contactIndividualId": null,
"referenceSource": "Stripe",
"referenceId": "cus_123456",
"createdDateTimeUtc": "2026-09-30T14:22:00Z",
"modifiedDateTimeUtc": "2026-09-30T14:22:00Z"
}
],
"total": 1
}{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The number of records to skip; must be zero or greater.
Required range:
x >= 0The number of records to return; must be between 1 and 1000.
Required range:
1 <= x <= 1000Body
application/json
Query groups and conditions.
Last modified on October 1, 2026
Was this page helpful?