Skip to main content
POST
/
api
/
ContactIndividual
/
Query
Query Individuals
curl --request POST \
  --url https://api.virtuoussoftware.com/api/ContactIndividual/Query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groups": [
    {
      "conditions": [
        {
          "parameter": "<string>",
          "operator": "<string>",
          "value": "<string>",
          "secondaryValue": "<string>",
          "values": [
            "<string>",
            "<string>"
          ]
        },
        {
          "parameter": "<string>",
          "operator": "<string>",
          "value": "<string>",
          "secondaryValue": "<string>",
          "values": [
            "<string>",
            "<string>"
          ]
        }
      ]
    },
    {
      "conditions": [
        {
          "parameter": "<string>",
          "operator": "<string>",
          "value": "<string>",
          "secondaryValue": "<string>",
          "values": [
            "<string>",
            "<string>"
          ]
        },
        {
          "parameter": "<string>",
          "operator": "<string>",
          "value": "<string>",
          "secondaryValue": "<string>",
          "values": [
            "<string>",
            "<string>"
          ]
        }
      ]
    }
  ],
  "sortBy": "<string>",
  "descending": "<boolean>"
}
'
{
  "list": [
    {
      "id": "<integer>",
      "contactId": "<integer>",
      "prefix": "<string>",
      "firstName": "<string>",
      "middleName": "<string>",
      "lastName": "<string>",
      "suffix": "<string>",
      "gender": "<string>",
      "isPrimary": "<boolean>",
      "canBePrimary": "<boolean>",
      "isSecondary": "<boolean>",
      "canBeSecondary": "<boolean>",
      "birthMonth": "<integer>",
      "birthDay": "<integer>",
      "birthYear": "<integer>",
      "birthDate": "<string>",
      "approximateAge": "<integer>",
      "isDeceased": "<boolean>",
      "passion": "<string>",
      "avatarUrl": "<string>",
      "contactMethods": [
        {
          "id": "<integer>",
          "type": "<string>",
          "value": "<string>",
          "isOptedIn": "<boolean>",
          "isPrimary": "<boolean>",
          "canBePrimary": "<boolean>"
        },
        {
          "id": "<integer>",
          "type": "<string>",
          "value": "<string>",
          "isOptedIn": "<boolean>",
          "isPrimary": "<boolean>",
          "canBePrimary": "<boolean>"
        }
      ],
      "createDateTimeUtc": "<dateTime>",
      "createdByUser": "<string>",
      "modifiedDateTimeUtc": "<dateTime>",
      "modifiedByUser": "<string>",
      "customFields": [
        {
          "name": "<string>",
          "value": "<string>",
          "displayName": "<string>"
        },
        {
          "name": "<string>",
          "value": "<string>",
          "displayName": "<string>"
        }
      ],
      "customCollections": [
        {
          "customCollectionId": "<integer>",
          "customCollectionName": "<string>",
          "collectionInstanceId": "<integer>",
          "fields": [
            {
              "name": "<string>",
              "value": "<string>"
            },
            {
              "name": "<string>",
              "value": "<string>"
            }
          ]
        },
        {
          "customCollectionId": "<integer>",
          "customCollectionName": "<string>",
          "collectionInstanceId": "<integer>",
          "fields": [
            {
              "name": "<string>",
              "value": "<string>"
            },
            {
              "name": "<string>",
              "value": "<string>"
            }
          ]
        }
      ]
    },
    {
      "id": "<integer>",
      "contactId": "<integer>",
      "prefix": "<string>",
      "firstName": "<string>",
      "middleName": "<string>",
      "lastName": "<string>",
      "suffix": "<string>",
      "gender": "<string>",
      "isPrimary": "<boolean>",
      "canBePrimary": "<boolean>",
      "isSecondary": "<boolean>",
      "canBeSecondary": "<boolean>",
      "birthMonth": "<integer>",
      "birthDay": "<integer>",
      "birthYear": "<integer>",
      "birthDate": "<string>",
      "approximateAge": "<integer>",
      "isDeceased": "<boolean>",
      "passion": "<string>",
      "avatarUrl": "<string>",
      "contactMethods": [
        {
          "id": "<integer>",
          "type": "<string>",
          "value": "<string>",
          "isOptedIn": "<boolean>",
          "isPrimary": "<boolean>",
          "canBePrimary": "<boolean>"
        },
        {
          "id": "<integer>",
          "type": "<string>",
          "value": "<string>",
          "isOptedIn": "<boolean>",
          "isPrimary": "<boolean>",
          "canBePrimary": "<boolean>"
        }
      ],
      "createDateTimeUtc": "<dateTime>",
      "createdByUser": "<string>",
      "modifiedDateTimeUtc": "<dateTime>",
      "modifiedByUser": "<string>",
      "customFields": [
        {
          "name": "<string>",
          "value": "<string>",
          "displayName": "<string>"
        },
        {
          "name": "<string>",
          "value": "<string>",
          "displayName": "<string>"
        }
      ],
      "customCollections": [
        {
          "customCollectionId": "<integer>",
          "customCollectionName": "<string>",
          "collectionInstanceId": "<integer>",
          "fields": [
            {
              "name": "<string>",
              "value": "<string>"
            },
            {
              "name": "<string>",
              "value": "<string>"
            }
          ]
        },
        {
          "customCollectionId": "<integer>",
          "customCollectionName": "<string>",
          "collectionInstanceId": "<integer>",
          "fields": [
            {
              "name": "<string>",
              "value": "<string>"
            },
            {
              "name": "<string>",
              "value": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "total": "<integer>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

skip
string

The number of records to skip. Default = 0.

take
string

The number of records to take. Default = 10. Max is 1000.

Body

application/json
groups
object[]
sortBy
string
descending
string

Response

OK

list
object[]
total
string
Last modified on June 5, 2026