Query Projects
POST {{baseUrl}}/api/Project/Query?skip=<integer>&take=<integer>
To see which options can be sent, use the {M:Virtuous.WebApi.Controllers.ProjectController.QueryOptions} endpoint. If you're going to consistently query for updated projects or new projects, don't. Use a webhook instead. If requests are timing out, you may be asking for too many items at once. The max take is 1,000.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
skip | string | The number of records to skip. Default = 0. | |
take | string | The number of records to take. Default = 10. Max is 1000. |
Request Body
{"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>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"list":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","projectCode":"\u003cstring\u003e","externalAccountingCode":"\u003cstring\u003e","onlineDisplayName":"\u003cstring\u003e","description":"\u003cstring\u003e","photoUrl":"\u003cstring\u003e","parentId":"\u003cinteger\u003e","parentName":"\u003cstring\u003e","isSubProject":"\u003cboolean\u003e","inventoryStatus":"\u003cstring\u003e","type":"\u003cstring\u003e","location":"\u003cstring\u003e","isRestrictedToGiftSpecifications":"\u003cboolean\u003e","isLimitedToFinancialNeed":"\u003cboolean\u003e","isPublic":"\u003cboolean\u003e","isActive":"\u003cboolean\u003e","isAvailableOnline":"\u003cboolean\u003e","isTaxDeductible":"\u003cboolean\u003e","treatAsAccountsPayable":"\u003cboolean\u003e","beginningBalance":"\u003cdouble\u003e","currentBalance":"\u003cdouble\u003e","financialNeedType":"\u003cstring\u003e","financialNeedFrequency":"\u003cstring\u003e","financialNeedAmount":"\u003cdouble\u003e","startDate":"\u003cdateTime\u003e","endDate":"\u003cdateTime\u003e","durationType":"\u003cstring\u003e","lifeToDateGiving":"\u003cdouble\u003e","lifeToDateGiftCount":"\u003cinteger\u003e","lifeToDateGiversCount":"\u003cinteger\u003e","lifeToDateExpenseTotal":"\u003cdouble\u003e","calendarYearToDateGiving":"\u003cdouble\u003e","calendarYearToDateGiftCount":"\u003cinteger\u003e","calendarYearToDateGiversCount":"\u003cinteger\u003e","calendarYearToDateExpenseTotal":"\u003cdouble\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","giftSpecifications":[{"amount":"\u003cdouble\u003e","frequency":"\u003cstring\u003e"},{"amount":"\u003cdouble\u003e","frequency":"\u003cstring\u003e"}],"customFields":"\u003cobject\u003e"},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","projectCode":"\u003cstring\u003e","externalAccountingCode":"\u003cstring\u003e","onlineDisplayName":"\u003cstring\u003e","description":"\u003cstring\u003e","photoUrl":"\u003cstring\u003e","parentId":"\u003cinteger\u003e","parentName":"\u003cstring\u003e","isSubProject":"\u003cboolean\u003e","inventoryStatus":"\u003cstring\u003e","type":"\u003cstring\u003e","location":"\u003cstring\u003e","isRestrictedToGiftSpecifications":"\u003cboolean\u003e","isLimitedToFinancialNeed":"\u003cboolean\u003e","isPublic":"\u003cboolean\u003e","isActive":"\u003cboolean\u003e","isAvailableOnline":"\u003cboolean\u003e","isTaxDeductible":"\u003cboolean\u003e","treatAsAccountsPayable":"\u003cboolean\u003e","beginningBalance":"\u003cdouble\u003e","currentBalance":"\u003cdouble\u003e","financialNeedType":"\u003cstring\u003e","financialNeedFrequency":"\u003cstring\u003e","financialNeedAmount":"\u003cdouble\u003e","startDate":"\u003cdateTime\u003e","endDate":"\u003cdateTime\u003e","durationType":"\u003cstring\u003e","lifeToDateGiving":"\u003cdouble\u003e","lifeToDateGiftCount":"\u003cinteger\u003e","lifeToDateGiversCount":"\u003cinteger\u003e","lifeToDateExpenseTotal":"\u003cdouble\u003e","calendarYearToDateGiving":"\u003cdouble\u003e","calendarYearToDateGiftCount":"\u003cinteger\u003e","calendarYearToDateGiversCount":"\u003cinteger\u003e","calendarYearToDateExpenseTotal":"\u003cdouble\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","giftSpecifications":[{"amount":"\u003cdouble\u003e","frequency":"\u003cstring\u003e"},{"amount":"\u003cdouble\u003e","frequency":"\u003cstring\u003e"}],"customFields":"\u003cobject\u003e"}],"total":"\u003cinteger\u003e"}