Query Planned Gifts
curl --request POST \
--url https://api.virtuoussoftware.com/api/PlannedGift/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>",
"plannedGiftUrl": "<string>",
"giftsAppliedUrl": "<string>",
"contactId": "<integer>",
"contactUrl": "<string>",
"plannedGiftDate": "<string>",
"pkannedGiftType": "<string>",
"frequency": "<string>",
"anticipatedAmount": "<string>",
"anticipatedStartDate": "<string>",
"numberOfOccurrences": "<integer>",
"currentValue": "<string>",
"fulfilled": "<string>",
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"segmentId": "<integer>",
"segment": "<string>",
"segmentUrl": "<string>",
"createDateTimeUtc": "<dateTime>",
"createdByUser": "<string>",
"modifiedDateTimeUtc": "<dateTime>",
"modifiedByUser": "<string>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
},
{
"id": "<integer>",
"plannedGiftUrl": "<string>",
"giftsAppliedUrl": "<string>",
"contactId": "<integer>",
"contactUrl": "<string>",
"plannedGiftDate": "<string>",
"pkannedGiftType": "<string>",
"frequency": "<string>",
"anticipatedAmount": "<string>",
"anticipatedStartDate": "<string>",
"numberOfOccurrences": "<integer>",
"currentValue": "<string>",
"fulfilled": "<string>",
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"segmentId": "<integer>",
"segment": "<string>",
"segmentUrl": "<string>",
"createDateTimeUtc": "<dateTime>",
"createdByUser": "<string>",
"modifiedDateTimeUtc": "<dateTime>",
"modifiedByUser": "<string>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}
],
"total": "<integer>"
}Planned Gifts
Query Planned Gifts
POST
/
api
/
PlannedGift
/
Query
Query Planned Gifts
curl --request POST \
--url https://api.virtuoussoftware.com/api/PlannedGift/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>",
"plannedGiftUrl": "<string>",
"giftsAppliedUrl": "<string>",
"contactId": "<integer>",
"contactUrl": "<string>",
"plannedGiftDate": "<string>",
"pkannedGiftType": "<string>",
"frequency": "<string>",
"anticipatedAmount": "<string>",
"anticipatedStartDate": "<string>",
"numberOfOccurrences": "<integer>",
"currentValue": "<string>",
"fulfilled": "<string>",
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"segmentId": "<integer>",
"segment": "<string>",
"segmentUrl": "<string>",
"createDateTimeUtc": "<dateTime>",
"createdByUser": "<string>",
"modifiedDateTimeUtc": "<dateTime>",
"modifiedByUser": "<string>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
},
{
"id": "<integer>",
"plannedGiftUrl": "<string>",
"giftsAppliedUrl": "<string>",
"contactId": "<integer>",
"contactUrl": "<string>",
"plannedGiftDate": "<string>",
"pkannedGiftType": "<string>",
"frequency": "<string>",
"anticipatedAmount": "<string>",
"anticipatedStartDate": "<string>",
"numberOfOccurrences": "<integer>",
"currentValue": "<string>",
"fulfilled": "<string>",
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"segmentId": "<integer>",
"segment": "<string>",
"segmentUrl": "<string>",
"createDateTimeUtc": "<dateTime>",
"createdByUser": "<string>",
"modifiedDateTimeUtc": "<dateTime>",
"modifiedByUser": "<string>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}
],
"total": "<integer>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The number of records to skip. Default = 0.
The number of records to take. Default = 10. Max is 1000.
Last modified on June 5, 2026
Was this page helpful?
⌘I