Query Pledges

Query Pledges

curl --request POST \
  --url https://api.virtuoussoftware.com/api/v2/Pledge/Query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groups": [
    {
      "conditions": [
        {
          "parameter": "<string:required>",
          "operator": "<string:required>",
          "value": "<string:optional>",
          "secondaryValue": "<string:optional>",
          "values": [
            "<string:optional>",
            "<string:optional>"
          ]
        },
        {
          "parameter": "<string:required>",
          "operator": "<string:required>",
          "value": "<string:optional>",
          "secondaryValue": "<string:optional>",
          "values": [
            "<string:optional>",
            "<string:optional>"
          ]
        }
      ]
    }
  ],
  "sortBy": "<string:optional:default=id>",
  "descending": "<boolean:optional:default=false>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    groups: [
      {
        conditions: [
          {
            parameter: '<string:required>',
            operator: '<string:required>',
            value: '<string:optional>',
            secondaryValue: '<string:optional>',
            values: ['<string:optional>', '<string:optional>']
          },
          {
            parameter: '<string:required>',
            operator: '<string:required>',
            value: '<string:optional>',
            secondaryValue: '<string:optional>',
            values: ['<string:optional>', '<string:optional>']
          }
        ]
      }
    ],
    sortBy: '<string:optional:default=id>',
    descending: '<boolean:optional:default=false>'
  })
};

fetch('https://api.virtuoussoftware.com/api/v2/Pledge/Query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.virtuoussoftware.com/api/v2/Pledge/Query"

payload = {
    "groups": [{ "conditions": [
                {
                    "parameter": "<string:required>",
                    "operator": "<string:required>",
                    "value": "<string:optional>",
                    "secondaryValue": "<string:optional>",
                    "values": ["<string:optional>", "<string:optional>"]
                },
                {
                    "parameter": "<string:required>",
                    "operator": "<string:required>",
                    "value": "<string:optional>",
                    "secondaryValue": "<string:optional>",
                    "values": ["<string:optional>", "<string:optional>"]
                }
            ] }],
    "sortBy": "<string:optional:default=id>",
    "descending": "<boolean:optional:default=false>"
}
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/v2/Pledge/Query");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"groups\": [\n    {\n      \"conditions\": [\n        {\n          \"parameter\": \"<string:required>\",\n          \"operator\": \"<string:required>\",\n          \"value\": \"<string:optional>\",\n          \"secondaryValue\": \"<string:optional>\",\n          \"values\": [\n            \"<string:optional>\",\n            \"<string:optional>\"\n          ]\n        },\n        {\n          \"parameter\": \"<string:required>\",\n          \"operator\": \"<string:required>\",\n          \"value\": \"<string:optional>\",\n          \"secondaryValue\": \"<string:optional>\",\n          \"values\": [\n            \"<string:optional>\",\n            \"<string:optional>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"sortBy\": \"<string:optional:default=id>\",\n  \"descending\": \"<boolean:optional:default=false>\"\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/v2/Pledge/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' => [
        [
                'conditions' => [
                                [
                                                                'parameter' => '<string:required>',
                                                                'operator' => '<string:required>',
                                                                'value' => '<string:optional>',
                                                                'secondaryValue' => '<string:optional>',
                                                                'values' => [
                                                                                                                                '<string:optional>',
                                                                                                                                '<string:optional>'
                                                                ]
                                ],
                                [
                                                                'parameter' => '<string:required>',
                                                                'operator' => '<string:required>',
                                                                'value' => '<string:optional>',
                                                                'secondaryValue' => '<string:optional>',
                                                                'values' => [
                                                                                                                                '<string:optional>',
                                                                                                                                '<string:optional>'
                                                                ]
                                ]
                ]
        ]
    ],
    'sortBy' => '<string:optional:default=id>',
    'descending' => '<boolean:optional:default=false>'
  ]),
  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/v2/Pledge/Query")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"groups\": [\n    {\n      \"conditions\": [\n        {\n          \"parameter\": \"<string:required>\",\n          \"operator\": \"<string:required>\",\n          \"value\": \"<string:optional>\",\n          \"secondaryValue\": \"<string:optional>\",\n          \"values\": [\n            \"<string:optional>\",\n            \"<string:optional>\"\n          ]\n        },\n        {\n          \"parameter\": \"<string:required>\",\n          \"operator\": \"<string:required>\",\n          \"value\": \"<string:optional>\",\n          \"secondaryValue\": \"<string:optional>\",\n          \"values\": [\n            \"<string:optional>\",\n            \"<string:optional>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"sortBy\": \"<string:optional:default=id>\",\n  \"descending\": \"<boolean:optional:default=false>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.virtuoussoftware.com/api/v2/Pledge/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      \"conditions\": [\n        {\n          \"parameter\": \"<string:required>\",\n          \"operator\": \"<string:required>\",\n          \"value\": \"<string:optional>\",\n          \"secondaryValue\": \"<string:optional>\",\n          \"values\": [\n            \"<string:optional>\",\n            \"<string:optional>\"\n          ]\n        },\n        {\n          \"parameter\": \"<string:required>\",\n          \"operator\": \"<string:required>\",\n          \"value\": \"<string:optional>\",\n          \"secondaryValue\": \"<string:optional>\",\n          \"values\": [\n            \"<string:optional>\",\n            \"<string:optional>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"sortBy\": \"<string:optional:default=id>\",\n  \"descending\": \"<boolean:optional:default=false>\"\n}"

response = http.request(request)
puts response.read_body

const url = 'https://api.virtuoussoftware.com/api/v2/Pledge/Query';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    groups: [
      {
        conditions: [
          {
            parameter: '<string:required>',
            operator: '<string:required>',
            value: '<string:optional>',
            secondaryValue: '<string:optional>',
            values: ['<string:optional>', '<string:optional>']
          },
          {
            parameter: '<string:required>',
            operator: '<string:required>',
            value: '<string:optional>',
            secondaryValue: '<string:optional>',
            values: ['<string:optional>', '<string:optional>']
          }
        ]
      }
    ],
    sortBy: '<string:optional:default=id>',
    descending: '<boolean:optional:default=false>'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "list": [
    {
      "id": 800045,
      "contactId": 100234,
      "amountPledged": 5000,
      "frequency": "Quarterly",
      "pledgeDate": "2025-03-01T00:00:00Z",
      "expectedFulfillmentDate": "2026-03-01T00:00:00Z",
      "createDateTimeUtc": "2025-03-01T11:00:00Z",
      "createdByUser": "Development Team",
      "modifiedDateTimeUtc": "2025-10-12T14:18:55Z",
      "modifiedByUser": "Gift Entry",
      "segmentId": 2012,
      "segment": "Capital Campaign — Phase II",
      "projectId": 1503,
      "project": "Building Renovation",
      "isPrivate": false,
      "status": "PartiallyFulfilled",
      "payments": [
        {
          "id": 900200,
          "expectedPaymentDate": "2025-06-01T00:00:00Z",
          "expectedAmount": 1000,
          "giftId": 500140,
          "actualAmount": 1000
        },
        {
          "id": 900201,
          "expectedPaymentDate": "2025-10-01T00:00:00Z",
          "expectedAmount": 1000,
          "giftId": 500142,
          "actualAmount": 1000
        }
      ],
      "customFields": []
    }
  ],
  "total": 88
}

{
  "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."
}

POST

api

Pledge

Query

Query Pledges

curl --request POST \
  --url https://api.virtuoussoftware.com/api/v2/Pledge/Query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groups": [
    {
      "conditions": [
        {
          "parameter": "<string:required>",
          "operator": "<string:required>",
          "value": "<string:optional>",
          "secondaryValue": "<string:optional>",
          "values": [
            "<string:optional>",
            "<string:optional>"
          ]
        },
        {
          "parameter": "<string:required>",
          "operator": "<string:required>",
          "value": "<string:optional>",
          "secondaryValue": "<string:optional>",
          "values": [
            "<string:optional>",
            "<string:optional>"
          ]
        }
      ]
    }
  ],
  "sortBy": "<string:optional:default=id>",
  "descending": "<boolean:optional:default=false>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    groups: [
      {
        conditions: [
          {
            parameter: '<string:required>',
            operator: '<string:required>',
            value: '<string:optional>',
            secondaryValue: '<string:optional>',
            values: ['<string:optional>', '<string:optional>']
          },
          {
            parameter: '<string:required>',
            operator: '<string:required>',
            value: '<string:optional>',
            secondaryValue: '<string:optional>',
            values: ['<string:optional>', '<string:optional>']
          }
        ]
      }
    ],
    sortBy: '<string:optional:default=id>',
    descending: '<boolean:optional:default=false>'
  })
};

fetch('https://api.virtuoussoftware.com/api/v2/Pledge/Query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.virtuoussoftware.com/api/v2/Pledge/Query"

payload = {
    "groups": [{ "conditions": [
                {
                    "parameter": "<string:required>",
                    "operator": "<string:required>",
                    "value": "<string:optional>",
                    "secondaryValue": "<string:optional>",
                    "values": ["<string:optional>", "<string:optional>"]
                },
                {
                    "parameter": "<string:required>",
                    "operator": "<string:required>",
                    "value": "<string:optional>",
                    "secondaryValue": "<string:optional>",
                    "values": ["<string:optional>", "<string:optional>"]
                }
            ] }],
    "sortBy": "<string:optional:default=id>",
    "descending": "<boolean:optional:default=false>"
}
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/v2/Pledge/Query");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"groups\": [\n    {\n      \"conditions\": [\n        {\n          \"parameter\": \"<string:required>\",\n          \"operator\": \"<string:required>\",\n          \"value\": \"<string:optional>\",\n          \"secondaryValue\": \"<string:optional>\",\n          \"values\": [\n            \"<string:optional>\",\n            \"<string:optional>\"\n          ]\n        },\n        {\n          \"parameter\": \"<string:required>\",\n          \"operator\": \"<string:required>\",\n          \"value\": \"<string:optional>\",\n          \"secondaryValue\": \"<string:optional>\",\n          \"values\": [\n            \"<string:optional>\",\n            \"<string:optional>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"sortBy\": \"<string:optional:default=id>\",\n  \"descending\": \"<boolean:optional:default=false>\"\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/v2/Pledge/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' => [
        [
                'conditions' => [
                                [
                                                                'parameter' => '<string:required>',
                                                                'operator' => '<string:required>',
                                                                'value' => '<string:optional>',
                                                                'secondaryValue' => '<string:optional>',
                                                                'values' => [
                                                                                                                                '<string:optional>',
                                                                                                                                '<string:optional>'
                                                                ]
                                ],
                                [
                                                                'parameter' => '<string:required>',
                                                                'operator' => '<string:required>',
                                                                'value' => '<string:optional>',
                                                                'secondaryValue' => '<string:optional>',
                                                                'values' => [
                                                                                                                                '<string:optional>',
                                                                                                                                '<string:optional>'
                                                                ]
                                ]
                ]
        ]
    ],
    'sortBy' => '<string:optional:default=id>',
    'descending' => '<boolean:optional:default=false>'
  ]),
  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/v2/Pledge/Query")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"groups\": [\n    {\n      \"conditions\": [\n        {\n          \"parameter\": \"<string:required>\",\n          \"operator\": \"<string:required>\",\n          \"value\": \"<string:optional>\",\n          \"secondaryValue\": \"<string:optional>\",\n          \"values\": [\n            \"<string:optional>\",\n            \"<string:optional>\"\n          ]\n        },\n        {\n          \"parameter\": \"<string:required>\",\n          \"operator\": \"<string:required>\",\n          \"value\": \"<string:optional>\",\n          \"secondaryValue\": \"<string:optional>\",\n          \"values\": [\n            \"<string:optional>\",\n            \"<string:optional>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"sortBy\": \"<string:optional:default=id>\",\n  \"descending\": \"<boolean:optional:default=false>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.virtuoussoftware.com/api/v2/Pledge/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      \"conditions\": [\n        {\n          \"parameter\": \"<string:required>\",\n          \"operator\": \"<string:required>\",\n          \"value\": \"<string:optional>\",\n          \"secondaryValue\": \"<string:optional>\",\n          \"values\": [\n            \"<string:optional>\",\n            \"<string:optional>\"\n          ]\n        },\n        {\n          \"parameter\": \"<string:required>\",\n          \"operator\": \"<string:required>\",\n          \"value\": \"<string:optional>\",\n          \"secondaryValue\": \"<string:optional>\",\n          \"values\": [\n            \"<string:optional>\",\n            \"<string:optional>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"sortBy\": \"<string:optional:default=id>\",\n  \"descending\": \"<boolean:optional:default=false>\"\n}"

response = http.request(request)
puts response.read_body

const url = 'https://api.virtuoussoftware.com/api/v2/Pledge/Query';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    groups: [
      {
        conditions: [
          {
            parameter: '<string:required>',
            operator: '<string:required>',
            value: '<string:optional>',
            secondaryValue: '<string:optional>',
            values: ['<string:optional>', '<string:optional>']
          },
          {
            parameter: '<string:required>',
            operator: '<string:required>',
            value: '<string:optional>',
            secondaryValue: '<string:optional>',
            values: ['<string:optional>', '<string:optional>']
          }
        ]
      }
    ],
    sortBy: '<string:optional:default=id>',
    descending: '<boolean:optional:default=false>'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "list": [
    {
      "id": 800045,
      "contactId": 100234,
      "amountPledged": 5000,
      "frequency": "Quarterly",
      "pledgeDate": "2025-03-01T00:00:00Z",
      "expectedFulfillmentDate": "2026-03-01T00:00:00Z",
      "createDateTimeUtc": "2025-03-01T11:00:00Z",
      "createdByUser": "Development Team",
      "modifiedDateTimeUtc": "2025-10-12T14:18:55Z",
      "modifiedByUser": "Gift Entry",
      "segmentId": 2012,
      "segment": "Capital Campaign — Phase II",
      "projectId": 1503,
      "project": "Building Renovation",
      "isPrivate": false,
      "status": "PartiallyFulfilled",
      "payments": [
        {
          "id": 900200,
          "expectedPaymentDate": "2025-06-01T00:00:00Z",
          "expectedAmount": 1000,
          "giftId": 500140,
          "actualAmount": 1000
        },
        {
          "id": 900201,
          "expectedPaymentDate": "2025-10-01T00:00:00Z",
          "expectedAmount": 1000,
          "giftId": 500142,
          "actualAmount": 1000
        }
      ],
      "customFields": []
    }
  ],
  "total": 88
}

{
  "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

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[]

The filter groups to apply. Conditions within a group are combined with AND, and the groups are combined with OR.

Show child attributes

sortBy

string

The field to sort the results by.

descending

string<style>

The direction to sort the results. Set to true to sort in descending order.

Response

list

object[]

The page of records matching the request.

Show child attributes

total

string

The total number of records matching the request, across all pages. Use it with skip and take to page through the results.

Last modified on August 11, 2026

⌘I

Account and Permissions

Contacts and Individuals

Giving

Campaigns

Projects

Events

Grants

Volunteering

Emails

Reminders (Deprecated)

Search

Tasks

Webhooks

Authorizations

Query Parameters

Body

Response