Get Recurring Gifts for a Contact
GET {{baseUrl}}/api/RecurringGift/ByContact/:contactId?sortBy=<string>&descending=<boolean>&skip=<integer>&take=<integer>
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
sortBy | string | The field to be sorted. Supported: Id, RecurringGiftDate, Amount, CreatedDateTime. | |
descending | string | The direction to be sorted. | |
skip | string | The number of records to skip. Default = 0. | |
take | string | The number of records to take. Default = 10. |
RESPONSES
status: OK
{"list":[{"id":"\u003cinteger\u003e","transactionSource":"\u003cstring\u003e","transactionId":"\u003cstring\u003e","contactId":"\u003cinteger\u003e","startDate":"\u003cdateTime\u003e","amount":"\u003cdouble\u003e","frequency":"\u003cstring\u003e","anticipatedEndDate":"\u003cdateTime\u003e","cancelDateTimeUtc":"\u003cdateTime\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","segmentId":"\u003cinteger\u003e","segment":"\u003cstring\u003e","segmentUrl":"\u003cstring\u003e","automatedPayments":"\u003cboolean\u003e","trackPayments":"\u003cboolean\u003e","isPrivate":"\u003cboolean\u003e","status":"\u003cstring\u003e","nextExpectedPaymentDate":"\u003cdateTime\u003e","designations":[{"projectId":"\u003cinteger\u003e","project":"\u003cstring\u003e","projectUrl":"\u003cstring\u003e","amountDesignated":"\u003cdouble\u003e","projectCode":"\u003cstring\u003e"},{"projectId":"\u003cinteger\u003e","project":"\u003cstring\u003e","projectUrl":"\u003cstring\u003e","amountDesignated":"\u003cdouble\u003e","projectCode":"\u003cstring\u003e"}],"customFields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"}]},{"id":"\u003cinteger\u003e","transactionSource":"\u003cstring\u003e","transactionId":"\u003cstring\u003e","contactId":"\u003cinteger\u003e","startDate":"\u003cdateTime\u003e","amount":"\u003cdouble\u003e","frequency":"\u003cstring\u003e","anticipatedEndDate":"\u003cdateTime\u003e","cancelDateTimeUtc":"\u003cdateTime\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","segmentId":"\u003cinteger\u003e","segment":"\u003cstring\u003e","segmentUrl":"\u003cstring\u003e","automatedPayments":"\u003cboolean\u003e","trackPayments":"\u003cboolean\u003e","isPrivate":"\u003cboolean\u003e","status":"\u003cstring\u003e","nextExpectedPaymentDate":"\u003cdateTime\u003e","designations":[{"projectId":"\u003cinteger\u003e","project":"\u003cstring\u003e","projectUrl":"\u003cstring\u003e","amountDesignated":"\u003cdouble\u003e","projectCode":"\u003cstring\u003e"},{"projectId":"\u003cinteger\u003e","project":"\u003cstring\u003e","projectUrl":"\u003cstring\u003e","amountDesignated":"\u003cdouble\u003e","projectCode":"\u003cstring\u003e"}],"customFields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"}]}],"total":"\u003cinteger\u003e"}