Query Pledges
POST {{baseUrl}}/api/v2/Pledge/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: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
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"list":[{"id":"\u003cinteger\u003e","contactId":"\u003cinteger\u003e","amountPledged":"\u003cdouble\u003e","frequency":"\u003cstring\u003e","pledgeDate":"\u003cdateTime\u003e","expectedFulfillmentDate":"\u003cdateTime\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","segmentId":"\u003cinteger\u003e","segment":"\u003cstring\u003e","projectId":"\u003cinteger\u003e","project":"\u003cstring\u003e","isPrivate":"\u003cboolean\u003e","status":"\u003cstring\u003e","payments":[{"id":"\u003cinteger\u003e","expectedPaymentDate":"\u003cdateTime\u003e","expectedAmount":"\u003cdouble\u003e","giftId":"\u003cinteger\u003e","actualAmount":"\u003cdouble\u003e"},{"id":"\u003cinteger\u003e","expectedPaymentDate":"\u003cdateTime\u003e","expectedAmount":"\u003cdouble\u003e","giftId":"\u003cinteger\u003e","actualAmount":"\u003cdouble\u003e"}],"customFields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"}]},{"id":"\u003cinteger\u003e","contactId":"\u003cinteger\u003e","amountPledged":"\u003cdouble\u003e","frequency":"\u003cstring\u003e","pledgeDate":"\u003cdateTime\u003e","expectedFulfillmentDate":"\u003cdateTime\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","segmentId":"\u003cinteger\u003e","segment":"\u003cstring\u003e","projectId":"\u003cinteger\u003e","project":"\u003cstring\u003e","isPrivate":"\u003cboolean\u003e","status":"\u003cstring\u003e","payments":[{"id":"\u003cinteger\u003e","expectedPaymentDate":"\u003cdateTime\u003e","expectedAmount":"\u003cdouble\u003e","giftId":"\u003cinteger\u003e","actualAmount":"\u003cdouble\u003e"},{"id":"\u003cinteger\u003e","expectedPaymentDate":"\u003cdateTime\u003e","expectedAmount":"\u003cdouble\u003e","giftId":"\u003cinteger\u003e","actualAmount":"\u003cdouble\u003e"}],"customFields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"}]}],"total":"\u003cinteger\u003e"}