Skip to main content
POST
/
api
/
Project
/
Query
Query Projects
curl --request POST \
  --url https://api.virtuoussoftware.com/api/Project/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>",
      "name": "<string>",
      "projectCode": "<string>",
      "externalAccountingCode": "<string>",
      "onlineDisplayName": "<string>",
      "description": "<string>",
      "photoUrl": "<string>",
      "parentId": "<integer>",
      "parentName": "<string>",
      "isSubProject": "<boolean>",
      "inventoryStatus": "<string>",
      "type": "<string>",
      "location": "<string>",
      "isRestrictedToGiftSpecifications": "<boolean>",
      "isLimitedToFinancialNeed": "<boolean>",
      "isPublic": "<boolean>",
      "isActive": "<boolean>",
      "isAvailableOnline": "<boolean>",
      "isTaxDeductible": "<boolean>",
      "treatAsAccountsPayable": "<boolean>",
      "beginningBalance": "<double>",
      "currentBalance": "<double>",
      "financialNeedType": "<string>",
      "financialNeedFrequency": "<string>",
      "financialNeedAmount": "<double>",
      "startDate": "<dateTime>",
      "endDate": "<dateTime>",
      "durationType": "<string>",
      "lifeToDateGiving": "<double>",
      "lifeToDateGiftCount": "<integer>",
      "lifeToDateGiversCount": "<integer>",
      "lifeToDateExpenseTotal": "<double>",
      "calendarYearToDateGiving": "<double>",
      "calendarYearToDateGiftCount": "<integer>",
      "calendarYearToDateGiversCount": "<integer>",
      "calendarYearToDateExpenseTotal": "<double>",
      "createDateTimeUtc": "<dateTime>",
      "createdByUser": "<string>",
      "modifiedDateTimeUtc": "<dateTime>",
      "modifiedByUser": "<string>",
      "giftSpecifications": [
        {
          "amount": "<double>",
          "frequency": "<string>"
        },
        {
          "amount": "<double>",
          "frequency": "<string>"
        }
      ],
      "customFields": "<object>"
    },
    {
      "id": "<integer>",
      "name": "<string>",
      "projectCode": "<string>",
      "externalAccountingCode": "<string>",
      "onlineDisplayName": "<string>",
      "description": "<string>",
      "photoUrl": "<string>",
      "parentId": "<integer>",
      "parentName": "<string>",
      "isSubProject": "<boolean>",
      "inventoryStatus": "<string>",
      "type": "<string>",
      "location": "<string>",
      "isRestrictedToGiftSpecifications": "<boolean>",
      "isLimitedToFinancialNeed": "<boolean>",
      "isPublic": "<boolean>",
      "isActive": "<boolean>",
      "isAvailableOnline": "<boolean>",
      "isTaxDeductible": "<boolean>",
      "treatAsAccountsPayable": "<boolean>",
      "beginningBalance": "<double>",
      "currentBalance": "<double>",
      "financialNeedType": "<string>",
      "financialNeedFrequency": "<string>",
      "financialNeedAmount": "<double>",
      "startDate": "<dateTime>",
      "endDate": "<dateTime>",
      "durationType": "<string>",
      "lifeToDateGiving": "<double>",
      "lifeToDateGiftCount": "<integer>",
      "lifeToDateGiversCount": "<integer>",
      "lifeToDateExpenseTotal": "<double>",
      "calendarYearToDateGiving": "<double>",
      "calendarYearToDateGiftCount": "<integer>",
      "calendarYearToDateGiversCount": "<integer>",
      "calendarYearToDateExpenseTotal": "<double>",
      "createDateTimeUtc": "<dateTime>",
      "createdByUser": "<string>",
      "modifiedDateTimeUtc": "<dateTime>",
      "modifiedByUser": "<string>",
      "giftSpecifications": [
        {
          "amount": "<double>",
          "frequency": "<string>"
        },
        {
          "amount": "<double>",
          "frequency": "<string>"
        }
      ],
      "customFields": "<object>"
    }
  ],
  "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