Query Planned Gifts
POST {{baseUrl}}/api/PlannedGift/Query?skip=<integer>&take=<integer>
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","plannedGiftUrl":"\u003cstring\u003e","giftsAppliedUrl":"\u003cstring\u003e","contactId":"\u003cinteger\u003e","contactUrl":"\u003cstring\u003e","plannedGiftDate":"\u003cstring\u003e","pkannedGiftType":"\u003cstring\u003e","frequency":"\u003cstring\u003e","anticipatedAmount":"\u003cstring\u003e","anticipatedStartDate":"\u003cstring\u003e","numberOfOccurrences":"\u003cinteger\u003e","currentValue":"\u003cstring\u003e","fulfilled":"\u003cstring\u003e","projectId":"\u003cinteger\u003e","project":"\u003cstring\u003e","projectUrl":"\u003cstring\u003e","segmentId":"\u003cinteger\u003e","segment":"\u003cstring\u003e","segmentUrl":"\u003cstring\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","customFields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"}]},{"id":"\u003cinteger\u003e","plannedGiftUrl":"\u003cstring\u003e","giftsAppliedUrl":"\u003cstring\u003e","contactId":"\u003cinteger\u003e","contactUrl":"\u003cstring\u003e","plannedGiftDate":"\u003cstring\u003e","pkannedGiftType":"\u003cstring\u003e","frequency":"\u003cstring\u003e","anticipatedAmount":"\u003cstring\u003e","anticipatedStartDate":"\u003cstring\u003e","numberOfOccurrences":"\u003cinteger\u003e","currentValue":"\u003cstring\u003e","fulfilled":"\u003cstring\u003e","projectId":"\u003cinteger\u003e","project":"\u003cstring\u003e","projectUrl":"\u003cstring\u003e","segmentId":"\u003cinteger\u003e","segment":"\u003cstring\u003e","segmentUrl":"\u003cstring\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","customFields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"}]}],"total":"\u003cinteger\u003e"}