iDonate API v20220413
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Hello there! Welcome to the iDonate developer docs.
What is iDonate
iDonate is the leading fundraising software provider that exists to grow nonprofits. Its digital giving system uses integrated payment applications, performance analytics, and success coaching to ensure immediate and enduring growth. Through a commitment to generosity and innovation, iDonate has become the world’s standard for donation processing technology.
Let's get started.
Transaction Webhook
A transaction webhook can be configured to push updates to an external system. This can be used to keep your organization up to date on donations it has received. The transaction webhook will send one of two possible JSON payloads, create or update, via an HTTP POST request. See below for examples.
create
{"create": [{"transaction": Transaction}]}
update
{"update": [{"transaction": Transaction}]}
Event Webhook
An Event Webhook is more complex than a Transaction Webhook, but allows for different types of information to be monitored. An Event Webhook will have a variable payload that is determined by the Event Type, documented under Event Definitions.
Data API
The API is a set of endpoints that allows organizations to retrieve their transactions. How you use it is up to you! See the available endpoints below, you will need an apikey to be able to access the endpoints.
Where do I get an apikey?
To obtain an apikey used for authentication, contact iDonate Support and supply the user's email you would like to access the system on behalf of.
Event Definitions
Advocacy Page Updated
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_page.updated",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyPage ... */
}
}
An Advocate has changed properties on their Advocacy Page
- Event Type:
advocacy_page.updated - Payload Type: AdvocacyPage
Advocacy Program Archived
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_program.archived",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyProgram ... */
}
}
An Advocacy Program has been archived, either automatically or at an Organization Editor's request.
- Event Type:
advocacy_program.archived - Payload Type: AdvocacyProgram
Advocacy Program Created
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_program.created",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyProgram ... */
}
}
An Advocacy Program has been created by an Organization Editor
- Event Type:
advocacy_program.created - Payload Type: AdvocacyProgram
Advocacy Program Deleted
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_program.deleted",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyProgram ... */
}
}
An Advocacy Program has been deleted by an Organization Admin
- Event Type:
advocacy_program.deleted - Payload Type: AdvocacyProgram
Advocacy Program Expired
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_program.expired",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyProgram ... */
}
}
Advocacy Program Expired
- Event Type:
advocacy_program.expired - Payload Type: AdvocacyProgram
Advocacy Program Published
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_program.published",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyProgram ... */
}
}
An Advocacy Program has been published by an Organization Editor
- Event Type:
advocacy_program.published - Payload Type: AdvocacyProgram
Advocacy Program Unarchived
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_program.unarchived",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyProgram ... */
}
}
An Advocacy Program has been Unarchived by an Organization Editor
- Event Type:
advocacy_program.unarchived - Payload Type: AdvocacyProgram
Advocacy Program Unpublished
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_program.unpublished",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyProgram ... */
}
}
An Advocacy Program has been removed from publication by an Organization Editor
- Event Type:
advocacy_program.unpublished - Payload Type: AdvocacyProgram
Advocacy Program Updated
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_program.updated",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyProgram ... */
}
}
An Advocacy Program has been updated by an Organization Editor
- Event Type:
advocacy_program.updated - Payload Type: AdvocacyProgram
Advocacy Team Created
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_team.created",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyTeam ... */
}
}
An Advocacy Team has been created by an Advocate
- Event Type:
advocacy_team.created - Payload Type: AdvocacyTeam
Advocacy Team Member Joined
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_team.member_joined",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyTeamMember ... */
}
}
An Advocate has joined an existing Advocacy Team
- Event Type:
advocacy_team.member_joined - Payload Type: AdvocacyTeamMember
Advocacy Team Member Left
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_team.member_left",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyTeamMember ... */
}
}
An Advocate has left an Advocacy Team
- Event Type:
advocacy_team.member_left - Payload Type: AdvocacyTeamMember
Advocacy Team Member Milestone Reached
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_team.member_goal_progress",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyTeamMemberMilestone ... */
}
}
An Advocate's page has reached a Membership Goal milestone
- Event Type:
advocacy_team.member_goal_progress - Payload Type: AdvocacyTeamMemberMilestone
Advocacy Team Updated
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "advocacy_team.updated",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... AdvocacyTeam ... */
}
}
An Advocacy Team has been updated by the Advocacy Team's Captain
- Event Type:
advocacy_team.updated - Payload Type: AdvocacyTeam
Donor Cancelled Organization Schedules
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "donor.cancel_organization_schedules",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... OrganizationDonorSchedules ... */
}
}
All schedules owned by Donor on the Organization have been cancelled.
- Event Type:
donor.cancel_organization_schedules - Payload Type: OrganizationDonorSchedules
Donor Contact Update Requested
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "donor.contact_update_requested",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... OrganizationDonor ... */
}
}
Manual update on a Donor's Contact Record has been requested.
- Event Type:
donor.contact_update_requested - Payload Type: OrganizationDonor
Donor Contact Updated
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "donor.contact_updated",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... DonorContactUpdate ... */
}
}
A Donor's Contact record has been updated by any means
- Event Type:
donor.contact_updated - Payload Type: DonorContactUpdate
Donor Payment Method Updated
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "donor.payment_method_updated",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... OrganizationDonorSchedules ... */
}
}
Donor Payment Method Updated
- Event Type:
donor.payment_method_updated - Payload Type: OrganizationDonorSchedules
Donor Requested Organization Giving History
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "donor.request_organization_giving_history",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... OrganizationDonor ... */
}
}
Donor has requested their Giving History with an Organization
- Event Type:
donor.request_organization_giving_history - Payload Type: OrganizationDonor
Event Attendee Registered
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "event_registration.registered",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... EventRegistration ... */
}
}
An attendee has registered for an event
- Event Type:
event_registration.registered - Payload Type: EventRegistration
P2P Fundraiser Archived
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "p2p_fundraiser.archived",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... P2pFundraiser ... */
}
}
Fundraiser page has been archived
- Event Type:
p2p_fundraiser.archived - Payload Type: P2pFundraiser
P2P Fundraiser Created
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "p2p_fundraiser.created",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... P2pFundraiser ... */
}
}
P2P fundraiser has been created
- Event Type:
p2p_fundraiser.created - Payload Type: P2pFundraiser
P2P Fundraiser Milestone Reached
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "p2p_fundraiser.milestone_reached",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... P2pFundraiserMilestone ... */
}
}
A milestone has been reached on a Fundraiser
- Event Type:
p2p_fundraiser.milestone_reached - Payload Type: P2pFundraiserMilestone
P2P Fundraiser Update Posted
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "p2p_fundraiser.posted",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... P2pUpdate ... */
}
}
An update has been posted on a Fundraiser page
- Event Type:
p2p_fundraiser.posted - Payload Type: P2pUpdate
P2P Fundraiser Updated
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "p2p_fundraiser.updated",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... P2pFundraiser ... */
}
}
P2P fundraiser has been updated
- Event Type:
p2p_fundraiser.updated - Payload Type: P2pFundraiser
P2P Program Archived
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "p2p_program.archived",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... P2pProgram ... */
}
}
P2P fundraiser has been archived
- Event Type:
p2p_program.archived - Payload Type: P2pProgram
P2P Program Created
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "p2p_program.created",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... P2pProgram ... */
}
}
P2P program has been created
- Event Type:
p2p_program.created - Payload Type: P2pProgram
P2P Program Updated
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "p2p_program.updated",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... P2pProgram ... */
}
}
P2P program has been updated
- Event Type:
p2p_program.updated - Payload Type: P2pProgram
Recurring Donation Schedule Cancelled
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "recurring_donation_schedule.cancelled",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... RecurringDonationScheduleCancelled ... */
}
}
A Recurring Donation Schedule has been cancelled.
- Event Type:
recurring_donation_schedule.cancelled - Payload Type: RecurringDonationScheduleCancelled
Recurring Donation Schedule Created
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "recurring_donation_schedule.created",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... RecurringDonationSchedule ... */
}
}
Recurring Donation Schedule Created
- Event Type:
recurring_donation_schedule.created - Payload Type: RecurringDonationSchedule
Recurring Donation Schedule Donor Update Requested
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "recurring_donation_schedule.donor_update_requested",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... RecurringDonationSchedule ... */
}
}
A Recurring Donation Schedule is in need of manual update from the Donor
- Event Type:
recurring_donation_schedule.donor_update_requested - Payload Type: RecurringDonationSchedule
Recurring Donation Schedule Updated
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "recurring_donation_schedule.updated",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... RecurringDonationSchedule ... */
}
}
A Recurring Donation Schedule has been updated by any means.
- Event Type:
recurring_donation_schedule.updated - Payload Type: RecurringDonationSchedule
Transaction Approved
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "transaction.approved",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... Transaction ... */
}
}
A Donation Transaction has reached 'approved' status.
- Event Type:
transaction.approved - Payload Type: Transaction
Transaction Cancelled
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "transaction.cancelled",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... Transaction ... */
}
}
A Donation Transaction has reached 'cancelled' status.
- Event Type:
transaction.cancelled - Payload Type: Transaction
Transaction Completed
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "transaction.completed",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... Transaction ... */
}
}
A Donation Transaction has reached 'complete' status.
- Event Type:
transaction.completed - Payload Type: Transaction
Transaction Created
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "transaction.created",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... Transaction ... */
}
}
A Donation Transaction has been created by any means.
- Event Type:
transaction.created - Payload Type: Transaction
Transaction Pending
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "transaction.pending",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... Transaction ... */
}
}
A Donation Transaction has reached 'pending' status.
- Event Type:
transaction.pending - Payload Type: Transaction
Transaction Refunded
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "transaction.refunded",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... Transaction ... */
}
}
A Donation Transaction has reached 'refunded' status.
- Event Type:
transaction.refunded - Payload Type: Transaction
Transaction Set Changed
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "transaction_set.changed",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... TransactionSet ... */
}
}
A transaction has been added or removed from an existing TransactionSet.
- Event Type:
transaction_set.changed - Payload Type: TransactionSet
Transaction Set Created
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "transaction_set.created",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... TransactionSet ... */
}
}
One or more Transactions have been created as a set.
- Event Type:
transaction_set.created - Payload Type: TransactionSet
Transaction Sold
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "transaction.sold",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... Transaction ... */
}
}
A Donation Transaction has reached 'Sold' status.
- Event Type:
transaction.sold - Payload Type: Transaction
Transaction Transferred
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "transaction.transferred",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... Transaction ... */
}
}
A Donation Transaction has reached 'transferred' status.
- Event Type:
transaction.transferred - Payload Type: Transaction
Transaction Updated
{
"id": "12345678-1234-1234-1234-123456789012",
"type": "transaction.updated",
"created": "2018-06-11T18:16:15Z",
"payload": {
/* ... Transaction ... */
}
}
Monitored fields on a Donation Transaction have been updated by any means.
- Event Type:
transaction.updated - Payload Type: Transaction
Base URLs:
Authentication
-
API Key (header_apikey)
- Parameter Name: apikey, in: header.
-
API Key (query_arg_apikey)
- Parameter Name: apikey, in: query.
Transactions
list_transaction_sets
Code samples
# You can also use wget
curl -X GET https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets \
-H 'Accept: application/json' \
-H 'apikey: API_KEY'
GET https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets HTTP/1.1
Host:
Accept: application/json
var headers = {
'Accept':'application/json',
'apikey':'API_KEY'
};
$.ajax({
url: 'https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'apikey' => 'API_KEY'
}
result = RestClient.get 'https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'apikey': 'API_KEY'
}
r = requests.get('https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets', params={
}, headers = headers)
print r.json()
'application/json',
'apikey' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"apikey": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /organization/{organization_id}/transaction-sets
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | false | Page Number, Integer |
| per_page | query | string | false | Results Per Page, Integer, 1-100 |
| start_date | query | string | false | Start of duration being queried, REQUIRED, ISO8601 |
| end_date | query | string | false | End of duration being queried, REQUIRED, ISO8601 |
| include_children | query | string | false | If true, also return data for child organizations, Boolean |
| organization_id | path | string | true | No description |
Example responses
200 undefined
{
"result": {
"count": 0,
"items": [
{
"created": "2019-08-24T14:15:22Z",
"id": "string",
"organization_id": "string",
"transactions": [
{
"additional_info": "string",
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"advocacy_program_id": "string",
"advocacy_program_name": "string",
"advocacy_team_id": "string",
"advocacy_team_name": "string",
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"advocate_id": "string",
"advocate_name": "string",
"campaign_id": "string",
"campaign_title": "string",
"card_type": "string",
"check_number": "string",
"client_proceeds": 0,
"company_name": "string",
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"corporate_matching_record": {
"company_name": "string",
"donation_id": 0,
"matched_transaction_id": "string"
},
"created": "2019-08-24T14:15:22Z",
"custom_note_1": "string",
"custom_note_2": "string",
"custom_note_3": "string",
"custom_note_4": "string",
"custom_note_5": "string",
"customer_meta": {},
"description": "string",
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
},
"designation_note": "string",
"donor_id": "string",
"donor_paid_fee": 0,
"email_opt_in": true,
"embed": {
"id": "string",
"name": "string"
},
"expiration_month": 0,
"expiration_year": 0,
"external_tracking_id": "string",
"final_date": "2019-08-24T14:15:22Z",
"frequency": "string",
"gift": {
"created": "2019-08-24T14:15:22Z",
"description": "string",
"extra_placeholder": "string",
"gift_value": 0,
"id": "string",
"image_url": "string",
"is_disabled": true,
"sku": "string",
"updated": "2019-08-24T14:15:22Z"
},
"gift_extra": "string",
"hide_name": true,
"id": "string",
"last_four_digits": "string",
"net_proceeds": 0,
"organization_event_id": "string",
"organization_id": "string",
"p2p_fundraiser_id": "string",
"p2p_fundraiser_name": "string",
"p2p_fundraiser_title": "string",
"p2p_program_id": "string",
"p2p_program_name": "string",
"p2p_team_id": "string",
"p2p_team_name": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"payment_transaction_id": "string",
"recurring_count": 0,
"reference_code": "string",
"sale_price": 0,
"schedule_id": "string",
"sms_keyword": "string",
"status": "string",
"subtype": "string",
"transaction_set_id": "string",
"tribute": {
"definition": {
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
},
"from_name": "string",
"honorees": [
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
],
"include_amount": true,
"recipient": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"send_card": true
},
"type": "string",
"utm": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string"
},
"vendor_id": 0
}
]
}
],
"more": true,
"page": 0,
"total_count": 0
},
"status": 200
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TransactionSetsResponse |
get_transaction_set
Code samples
# You can also use wget
curl -X GET https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets/{transaction_set_id} \
-H 'Accept: application/json' \
-H 'apikey: API_KEY'
GET https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets/{transaction_set_id} HTTP/1.1
Host:
Accept: application/json
var headers = {
'Accept':'application/json',
'apikey':'API_KEY'
};
$.ajax({
url: 'https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets/{transaction_set_id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'apikey' => 'API_KEY'
}
result = RestClient.get 'https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets/{transaction_set_id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'apikey': 'API_KEY'
}
r = requests.get('https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets/{transaction_set_id}', params={
}, headers = headers)
print r.json()
'application/json',
'apikey' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets/{transaction_set_id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets/{transaction_set_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"apikey": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://$API_HOST/data/20220413/organization/{organization_id}/transaction-sets/{transaction_set_id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /organization/{organization_id}/transaction-sets/{transaction_set_id}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| organization_id | path | string | true | No description |
| transaction_set_id | path | string | true | No description |
Example responses
200 undefined
{
"result": {
"created": "2019-08-24T14:15:22Z",
"id": "string",
"organization_id": "string",
"transactions": [
{
"additional_info": "string",
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"advocacy_program_id": "string",
"advocacy_program_name": "string",
"advocacy_team_id": "string",
"advocacy_team_name": "string",
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"advocate_id": "string",
"advocate_name": "string",
"campaign_id": "string",
"campaign_title": "string",
"card_type": "string",
"check_number": "string",
"client_proceeds": 0,
"company_name": "string",
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"corporate_matching_record": {
"company_name": "string",
"donation_id": 0,
"matched_transaction_id": "string"
},
"created": "2019-08-24T14:15:22Z",
"custom_note_1": "string",
"custom_note_2": "string",
"custom_note_3": "string",
"custom_note_4": "string",
"custom_note_5": "string",
"customer_meta": {},
"description": "string",
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
},
"designation_note": "string",
"donor_id": "string",
"donor_paid_fee": 0,
"email_opt_in": true,
"embed": {
"id": "string",
"name": "string"
},
"expiration_month": 0,
"expiration_year": 0,
"external_tracking_id": "string",
"final_date": "2019-08-24T14:15:22Z",
"frequency": "string",
"gift": {
"created": "2019-08-24T14:15:22Z",
"description": "string",
"extra_placeholder": "string",
"gift_value": 0,
"id": "string",
"image_url": "string",
"is_disabled": true,
"sku": "string",
"updated": "2019-08-24T14:15:22Z"
},
"gift_extra": "string",
"hide_name": true,
"id": "string",
"last_four_digits": "string",
"net_proceeds": 0,
"organization_event_id": "string",
"organization_id": "string",
"p2p_fundraiser_id": "string",
"p2p_fundraiser_name": "string",
"p2p_fundraiser_title": "string",
"p2p_program_id": "string",
"p2p_program_name": "string",
"p2p_team_id": "string",
"p2p_team_name": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"payment_transaction_id": "string",
"recurring_count": 0,
"reference_code": "string",
"sale_price": 0,
"schedule_id": "string",
"sms_keyword": "string",
"status": "string",
"subtype": "string",
"transaction_set_id": "string",
"tribute": {
"definition": {
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
},
"from_name": "string",
"honorees": [
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
],
"include_amount": true,
"recipient": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"send_card": true
},
"type": "string",
"utm": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string"
},
"vendor_id": 0
}
]
},
"status": 200
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TransactionSetResponse |
list_transactions
Code samples
# You can also use wget
curl -X GET https://$API_HOST/data/20220413/organization/{organization_id}/transactions \
-H 'Accept: application/json' \
-H 'apikey: API_KEY'
GET https://$API_HOST/data/20220413/organization/{organization_id}/transactions HTTP/1.1
Host:
Accept: application/json
var headers = {
'Accept':'application/json',
'apikey':'API_KEY'
};
$.ajax({
url: 'https://$API_HOST/data/20220413/organization/{organization_id}/transactions',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'apikey' => 'API_KEY'
}
result = RestClient.get 'https://$API_HOST/data/20220413/organization/{organization_id}/transactions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'apikey': 'API_KEY'
}
r = requests.get('https://$API_HOST/data/20220413/organization/{organization_id}/transactions', params={
}, headers = headers)
print r.json()
'application/json',
'apikey' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$API_HOST/data/20220413/organization/{organization_id}/transactions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://$API_HOST/data/20220413/organization/{organization_id}/transactions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"apikey": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://$API_HOST/data/20220413/organization/{organization_id}/transactions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /organization/{organization_id}/transactions
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | false | Page Number, Integer |
| per_page | query | string | false | Results Per Page, Integer, 1-100 |
| start_date | query | string | false | Start of duration being queried, REQUIRED, ISO8601 |
| end_date | query | string | false | End of duration being queried, REQUIRED, ISO8601 |
| include_children | query | string | false | If true, also return data for child organizations, Boolean |
| organization_id | path | string | true | No description |
Example responses
200 undefined
{
"result": {
"count": 0,
"items": [
{
"additional_info": "string",
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"advocacy_program_id": "string",
"advocacy_program_name": "string",
"advocacy_team_id": "string",
"advocacy_team_name": "string",
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"advocate_id": "string",
"advocate_name": "string",
"campaign_id": "string",
"campaign_title": "string",
"card_type": "string",
"check_number": "string",
"client_proceeds": 0,
"company_name": "string",
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"corporate_matching_record": {
"company_name": "string",
"donation_id": 0,
"matched_transaction_id": "string"
},
"created": "2019-08-24T14:15:22Z",
"custom_note_1": "string",
"custom_note_2": "string",
"custom_note_3": "string",
"custom_note_4": "string",
"custom_note_5": "string",
"customer_meta": {},
"description": "string",
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
},
"designation_note": "string",
"donor_id": "string",
"donor_paid_fee": 0,
"email_opt_in": true,
"embed": {
"id": "string",
"name": "string"
},
"expiration_month": 0,
"expiration_year": 0,
"external_tracking_id": "string",
"final_date": "2019-08-24T14:15:22Z",
"frequency": "string",
"gift": {
"created": "2019-08-24T14:15:22Z",
"description": "string",
"extra_placeholder": "string",
"gift_value": 0,
"id": "string",
"image_url": "string",
"is_disabled": true,
"sku": "string",
"updated": "2019-08-24T14:15:22Z"
},
"gift_extra": "string",
"hide_name": true,
"id": "string",
"last_four_digits": "string",
"net_proceeds": 0,
"organization_event_id": "string",
"organization_id": "string",
"p2p_fundraiser_id": "string",
"p2p_fundraiser_name": "string",
"p2p_fundraiser_title": "string",
"p2p_program_id": "string",
"p2p_program_name": "string",
"p2p_team_id": "string",
"p2p_team_name": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"payment_transaction_id": "string",
"recurring_count": 0,
"reference_code": "string",
"sale_price": 0,
"schedule_id": "string",
"sms_keyword": "string",
"status": "string",
"subtype": "string",
"transaction_set_id": "string",
"tribute": {
"definition": {
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
},
"from_name": "string",
"honorees": [
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
],
"include_amount": true,
"recipient": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"send_card": true
},
"type": "string",
"utm": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string"
},
"vendor_id": 0
}
],
"more": true,
"page": 0,
"total_count": 0
},
"status": 200
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TransactionsResponse |
get_transaction
Code samples
# You can also use wget
curl -X GET https://$API_HOST/data/20220413/organization/{organization_id}/transactions/{transaction_id} \
-H 'Accept: application/json' \
-H 'apikey: API_KEY'
GET https://$API_HOST/data/20220413/organization/{organization_id}/transactions/{transaction_id} HTTP/1.1
Host:
Accept: application/json
var headers = {
'Accept':'application/json',
'apikey':'API_KEY'
};
$.ajax({
url: 'https://$API_HOST/data/20220413/organization/{organization_id}/transactions/{transaction_id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'apikey' => 'API_KEY'
}
result = RestClient.get 'https://$API_HOST/data/20220413/organization/{organization_id}/transactions/{transaction_id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'apikey': 'API_KEY'
}
r = requests.get('https://$API_HOST/data/20220413/organization/{organization_id}/transactions/{transaction_id}', params={
}, headers = headers)
print r.json()
'application/json',
'apikey' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$API_HOST/data/20220413/organization/{organization_id}/transactions/{transaction_id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://$API_HOST/data/20220413/organization/{organization_id}/transactions/{transaction_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"apikey": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://$API_HOST/data/20220413/organization/{organization_id}/transactions/{transaction_id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /organization/{organization_id}/transactions/{transaction_id}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| organization_id | path | string | true | No description |
| transaction_id | path | string | true | No description |
Example responses
200 undefined
{
"result": {
"additional_info": "string",
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"advocacy_program_id": "string",
"advocacy_program_name": "string",
"advocacy_team_id": "string",
"advocacy_team_name": "string",
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"advocate_id": "string",
"advocate_name": "string",
"campaign_id": "string",
"campaign_title": "string",
"card_type": "string",
"check_number": "string",
"client_proceeds": 0,
"company_name": "string",
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"corporate_matching_record": {
"company_name": "string",
"donation_id": 0,
"matched_transaction_id": "string"
},
"created": "2019-08-24T14:15:22Z",
"custom_note_1": "string",
"custom_note_2": "string",
"custom_note_3": "string",
"custom_note_4": "string",
"custom_note_5": "string",
"customer_meta": {},
"description": "string",
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
},
"designation_note": "string",
"donor_id": "string",
"donor_paid_fee": 0,
"email_opt_in": true,
"embed": {
"id": "string",
"name": "string"
},
"expiration_month": 0,
"expiration_year": 0,
"external_tracking_id": "string",
"final_date": "2019-08-24T14:15:22Z",
"frequency": "string",
"gift": {
"created": "2019-08-24T14:15:22Z",
"description": "string",
"extra_placeholder": "string",
"gift_value": 0,
"id": "string",
"image_url": "string",
"is_disabled": true,
"sku": "string",
"updated": "2019-08-24T14:15:22Z"
},
"gift_extra": "string",
"hide_name": true,
"id": "string",
"last_four_digits": "string",
"net_proceeds": 0,
"organization_event_id": "string",
"organization_id": "string",
"p2p_fundraiser_id": "string",
"p2p_fundraiser_name": "string",
"p2p_fundraiser_title": "string",
"p2p_program_id": "string",
"p2p_program_name": "string",
"p2p_team_id": "string",
"p2p_team_name": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"payment_transaction_id": "string",
"recurring_count": 0,
"reference_code": "string",
"sale_price": 0,
"schedule_id": "string",
"sms_keyword": "string",
"status": "string",
"subtype": "string",
"transaction_set_id": "string",
"tribute": {
"definition": {
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
},
"from_name": "string",
"honorees": [
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
],
"include_amount": true,
"recipient": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"send_card": true
},
"type": "string",
"utm": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string"
},
"vendor_id": 0
},
"status": 200
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | TransactionResponse |
Recurring Schedules
list_recurring_schedules
Code samples
# You can also use wget
curl -X GET https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules \
-H 'Accept: application/json' \
-H 'apikey: API_KEY'
GET https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules HTTP/1.1
Host:
Accept: application/json
var headers = {
'Accept':'application/json',
'apikey':'API_KEY'
};
$.ajax({
url: 'https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'apikey' => 'API_KEY'
}
result = RestClient.get 'https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'apikey': 'API_KEY'
}
r = requests.get('https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules', params={
}, headers = headers)
print r.json()
'application/json',
'apikey' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"apikey": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /organization/{organization_id}/recurring-schedules
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | false | Page Number, Integer |
| per_page | query | string | false | Results Per Page, Integer, 1-100 |
| creation_start_date | query | string | false | Start of duration (from schedule creation) being queried, REQUIRED, ISO8601 |
| creation_end_date | query | string | false | End of duration (from schedule creation) being queried, REQUIRED, ISO8601 |
| schedule_start_date | query | string | false | Start of duration (from first transaction) being queried, REQUIRED, ISO8601 |
| schedule_end_date | query | string | false | End of duration (from first transaction) being queried, REQUIRED, ISO8601 |
| include_children | query | string | false | If true, also return data for child organizations, Boolean |
| organization_id | path | string | true | No description |
Example responses
200 undefined
{
"result": {
"count": 0,
"items": {
"amount": "string",
"company_name": "string",
"customer_meta": {},
"designations": [
{
"amount": 0,
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
}
}
],
"donor": {
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"display_name": "string",
"id": "string"
},
"donor_paid_fee": "string",
"expires": "2019-08-24T14:15:22Z",
"history": [
{
"attribute": "string",
"new_value": {},
"old_value": {},
"reason": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": "string"
}
],
"id": "string",
"is_company": true,
"next_payment": "2019-08-24T14:15:22Z",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"reference_code": "string",
"schedule_type": "string",
"start_date": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
},
"more": true,
"page": 0,
"total_count": 0
},
"status": 200
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | RecurringSchedulesResponse |
get_recurring_schedule
Code samples
# You can also use wget
curl -X GET https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules/{recurring_schedule_id} \
-H 'Accept: application/json' \
-H 'apikey: API_KEY'
GET https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules/{recurring_schedule_id} HTTP/1.1
Host:
Accept: application/json
var headers = {
'Accept':'application/json',
'apikey':'API_KEY'
};
$.ajax({
url: 'https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules/{recurring_schedule_id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'apikey' => 'API_KEY'
}
result = RestClient.get 'https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules/{recurring_schedule_id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'apikey': 'API_KEY'
}
r = requests.get('https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules/{recurring_schedule_id}', params={
}, headers = headers)
print r.json()
'application/json',
'apikey' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules/{recurring_schedule_id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules/{recurring_schedule_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"apikey": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://$API_HOST/data/20220413/organization/{organization_id}/recurring-schedules/{recurring_schedule_id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /organization/{organization_id}/recurring-schedules/{recurring_schedule_id}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| organization_id | path | string | true | No description |
| recurring_schedule_id | path | string | true | No description |
Example responses
200 undefined
{
"result": {
"amount": "string",
"company_name": "string",
"customer_meta": {},
"designations": [
{
"amount": 0,
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
}
}
],
"donor": {
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"display_name": "string",
"id": "string"
},
"donor_paid_fee": "string",
"expires": "2019-08-24T14:15:22Z",
"history": [
{
"attribute": "string",
"new_value": {},
"old_value": {},
"reason": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": "string"
}
],
"id": "string",
"is_company": true,
"next_payment": "2019-08-24T14:15:22Z",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"reference_code": "string",
"schedule_type": "string",
"start_date": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
},
"status": 200
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | RecurringScheduleResponse |
Events
list_event_registrations
Code samples
# You can also use wget
curl -X GET https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations \
-H 'Accept: application/json' \
-H 'apikey: API_KEY'
GET https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations HTTP/1.1
Host:
Accept: application/json
var headers = {
'Accept':'application/json',
'apikey':'API_KEY'
};
$.ajax({
url: 'https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'apikey' => 'API_KEY'
}
result = RestClient.get 'https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'apikey': 'API_KEY'
}
r = requests.get('https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations', params={
}, headers = headers)
print r.json()
'application/json',
'apikey' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"apikey": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /organization/{organization_id}/event-registrations
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | false | Page Number, Integer |
| per_page | query | string | false | Results Per Page, Integer, 1-100 |
| start_date | query | string | false | Start of duration being queried, REQUIRED, ISO8601 |
| end_date | query | string | false | End of duration being queried, REQUIRED, ISO8601 |
| include_children | query | string | false | If true, also return data for child organizations, Boolean |
| organization_id | path | string | true | No description |
Example responses
200 undefined
{
"result": {
"count": 0,
"items": {
"guest_city": "string",
"guest_company": "string",
"guest_country": "string",
"guest_email": "string",
"guest_first_name": "string",
"guest_last_name": "string",
"guest_phone": "string",
"guest_salutation": "string",
"guest_state": "string",
"guest_street": "string",
"guest_street2": "string",
"guest_zip": "string",
"id": "string",
"organization_event": {
"event_end": "2019-08-24T14:15:22Z",
"event_metadata": {},
"event_start": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organization": {
"id": "string",
"name": "string"
}
},
"organization_id": "string",
"promo_code": {
"id": "string",
"name": "string"
},
"status": "string",
"survey_responses": [
{
"response": "string",
"survey_question": "string"
}
],
"ticket_definition": {
"id": "string",
"name": "string"
}
},
"more": true,
"page": 0,
"total_count": 0
},
"status": 200
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | EventRegistrationsResponse |
get_event_registration
Code samples
# You can also use wget
curl -X GET https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations/{event_registration_id} \
-H 'Accept: application/json' \
-H 'apikey: API_KEY'
GET https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations/{event_registration_id} HTTP/1.1
Host:
Accept: application/json
var headers = {
'Accept':'application/json',
'apikey':'API_KEY'
};
$.ajax({
url: 'https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations/{event_registration_id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'apikey' => 'API_KEY'
}
result = RestClient.get 'https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations/{event_registration_id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'apikey': 'API_KEY'
}
r = requests.get('https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations/{event_registration_id}', params={
}, headers = headers)
print r.json()
'application/json',
'apikey' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations/{event_registration_id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations/{event_registration_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"apikey": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://$API_HOST/data/20220413/organization/{organization_id}/event-registrations/{event_registration_id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /organization/{organization_id}/event-registrations/{event_registration_id}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| organization_id | path | string | true | No description |
| event_registration_id | path | string | true | No description |
Example responses
200 undefined
{
"result": {
"guest_city": "string",
"guest_company": "string",
"guest_country": "string",
"guest_email": "string",
"guest_first_name": "string",
"guest_last_name": "string",
"guest_phone": "string",
"guest_salutation": "string",
"guest_state": "string",
"guest_street": "string",
"guest_street2": "string",
"guest_zip": "string",
"id": "string",
"organization_event": {
"event_end": "2019-08-24T14:15:22Z",
"event_metadata": {},
"event_start": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organization": {
"id": "string",
"name": "string"
}
},
"organization_id": "string",
"promo_code": {
"id": "string",
"name": "string"
},
"status": "string",
"survey_responses": [
{
"response": "string",
"survey_question": "string"
}
],
"ticket_definition": {
"id": "string",
"name": "string"
}
},
"status": 200
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | EventRegistrationResponse |
Peer to Peer
list_p2p_fundraisers
Code samples
# You can also use wget
curl -X GET https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers \
-H 'Accept: application/json' \
-H 'apikey: API_KEY'
GET https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers HTTP/1.1
Host:
Accept: application/json
var headers = {
'Accept':'application/json',
'apikey':'API_KEY'
};
$.ajax({
url: 'https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'apikey' => 'API_KEY'
}
result = RestClient.get 'https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'apikey': 'API_KEY'
}
r = requests.get('https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers', params={
}, headers = headers)
print r.json()
'application/json',
'apikey' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"apikey": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /organization/{organization_id}/p2p-fundraisers
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | string | false | Page Number, Integer |
| per_page | query | string | false | Results Per Page, Integer, 1-100 |
| start_date | query | string | false | Start of duration being queried, REQUIRED, ISO8601 |
| end_date | query | string | false | End of duration being queried, REQUIRED, ISO8601 |
| organization_id | path | string | true | No description |
Example responses
200 undefined
{
"result": {
"count": 0,
"items": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"goal": "string",
"id": "string",
"name": "string",
"organization_id": "string",
"program": {
"description": "string",
"end_date": "2019-08-24T14:15:22Z",
"goal": 0,
"id": "string",
"include_donor_paid_fee": true,
"name": "string",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"status": "string"
},
"program_id": "string",
"status": "string",
"title": "string"
},
"more": true,
"page": 0,
"total_count": 0
},
"status": 200
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | P2PFundraisersResponse |
get_p2p_fundraiser
Code samples
# You can also use wget
curl -X GET https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers/{p2p_fundraiser_id} \
-H 'Accept: application/json' \
-H 'apikey: API_KEY'
GET https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers/{p2p_fundraiser_id} HTTP/1.1
Host:
Accept: application/json
var headers = {
'Accept':'application/json',
'apikey':'API_KEY'
};
$.ajax({
url: 'https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers/{p2p_fundraiser_id}',
method: 'get',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'apikey' => 'API_KEY'
}
result = RestClient.get 'https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers/{p2p_fundraiser_id}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'apikey': 'API_KEY'
}
r = requests.get('https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers/{p2p_fundraiser_id}', params={
}, headers = headers)
print r.json()
'application/json',
'apikey' => 'API_KEY',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers/{p2p_fundraiser_id}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers/{p2p_fundraiser_id}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"apikey": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://$API_HOST/data/20220413/organization/{organization_id}/p2p-fundraisers/{p2p_fundraiser_id}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /organization/{organization_id}/p2p-fundraisers/{p2p_fundraiser_id}
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| organization_id | path | string | true | No description |
| p2p_fundraiser_id | path | string | true | No description |
Example responses
200 undefined
{
"result": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"goal": "string",
"id": "string",
"name": "string",
"organization_id": "string",
"program": {
"description": "string",
"end_date": "2019-08-24T14:15:22Z",
"goal": 0,
"id": "string",
"include_donor_paid_fee": true,
"name": "string",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"status": "string"
},
"program_id": "string",
"status": "string",
"title": "string"
},
"status": 200
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | P2PFundraiserResponse |
Schemas
Address
{
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| city | string | false | No description |
| country | string | false | No description |
| country_code | string | false | No description |
| country_name | string | false | No description |
| state | string | false | No description |
| street | string | false | No description |
| street2 | string | false | No description |
| title | string | false | No description |
| zip | string | false | No description |
AdvocacyPage
{
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"organization_id": "string",
"team": {
"captain": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"id": "string",
"is_public": true,
"name": "string",
"organization_id": "string",
"program": {
"description": "string",
"end_date": "2019-08-24T14:15:22Z",
"goal": 0,
"id": "string",
"name": "string",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"status": "string"
}
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| advocate | Advocate | false | No description |
| organization_id | string | false | No description |
| team | AdvocacyTeam | false | No description |
AdvocacyProgram
{
"description": "string",
"end_date": "2019-08-24T14:15:22Z",
"goal": 0,
"id": "string",
"name": "string",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"status": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| description | string | false | No description |
| end_date | string(date-time) | false | No description |
| goal | number | false | No description |
| id | string | false | No description |
| name | string | false | No description |
| organization | OrganizationIDAndName | false | No description |
| organization_id | string | false | No description |
| start_date | string(date-time) | false | No description |
| status | string | false | No description |
AdvocacyTeam
{
"captain": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"id": "string",
"is_public": true,
"name": "string",
"organization_id": "string",
"program": {
"description": "string",
"end_date": "2019-08-24T14:15:22Z",
"goal": 0,
"id": "string",
"name": "string",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"status": "string"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| captain | Advocate | false | No description |
| id | string | false | No description |
| is_public | boolean | false | No description |
| name | string | false | No description |
| organization_id | string | false | No description |
| program | AdvocacyProgram | false | No description |
AdvocacyTeamMember
{
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"organization_id": "string",
"team": {
"captain": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"id": "string",
"is_public": true,
"name": "string",
"organization_id": "string",
"program": {
"description": "string",
"end_date": "2019-08-24T14:15:22Z",
"goal": 0,
"id": "string",
"name": "string",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"status": "string"
}
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| advocate | Advocate | false | No description |
| organization_id | string | false | No description |
| team | AdvocacyTeam | false | No description |
AdvocacyTeamMemberMilestone
{
"membership": {
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"organization_id": "string",
"team": {
"captain": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"id": "string",
"is_public": true,
"name": "string",
"organization_id": "string",
"program": {
"description": "string",
"end_date": "2019-08-24T14:15:22Z",
"goal": 0,
"id": "string",
"name": "string",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"status": "string"
}
}
},
"milestone": 0,
"organization_id": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| membership | AdvocacyTeamMember | false | No description |
| milestone | integer | false | No description |
| organization_id | string | false | No description |
Advocate
{
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| address | AdvocateAddress | false | No description |
| string | false | No description | |
| first_name | string | false | No description |
| id | string | false | No description |
| join_date | string(date-time) | false | No description |
| last_name | string | false | No description |
| phone | string | false | No description |
AdvocateAddress
{
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| city | string | false | No description |
| country | string | false | No description |
| state | string | false | No description |
| street | string | false | No description |
| street2 | string | false | No description |
| zip_code | string | false | No description |
Contact
{
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| address | Address | false | No description |
| created | string(date-time) | false | No description |
| string | false | No description | |
| firstname | string | false | No description |
| lastname | string | false | No description |
| middlename | string | false | No description |
| phone | string | false | No description |
| timezone | string | false | No description |
| title | string | false | No description |
| updated | string(date-time) | false | No description |
CorporateMatchingRecord
{
"company_name": "string",
"donation_id": 0,
"matched_transaction_id": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| company_name | string | false | No description |
| donation_id | integer | false | No description |
| matched_transaction_id | string | false | No description |
DesignatedAmount
{
"amount": 0,
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| amount | number | false | No description |
| designation | Designation | false | No description |
Designation
{
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| code | string | false | No description |
| fund_id | string | false | No description |
| id | string | false | No description |
| title | string | false | No description |
Donor
{
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"display_name": "string",
"id": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| contact | Contact | false | No description |
| display_name | string | false | No description |
| id | string | false | No description |
DonorContactUpdate
{
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"contact_old": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"id": "string",
"organization_id": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| contact | Contact | false | No description |
| contact_old | Contact | false | No description |
| id | string | false | No description |
| organization_id | string | false | No description |
Embed
{
"id": "string",
"name": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | false | No description |
| name | string | false | No description |
EventIDAndName
{
"event_end": "2019-08-24T14:15:22Z",
"event_metadata": {},
"event_start": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organization": {
"id": "string",
"name": "string"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| event_end | string(date-time) | false | No description |
| event_metadata | object | false | No description |
| event_start | string(date-time) | false | No description |
| id | string | false | No description |
| name | string | false | No description |
| organization | OrganizationIDAndName | false | No description |
EventRegistration
{
"guest_city": "string",
"guest_company": "string",
"guest_country": "string",
"guest_email": "string",
"guest_first_name": "string",
"guest_last_name": "string",
"guest_phone": "string",
"guest_salutation": "string",
"guest_state": "string",
"guest_street": "string",
"guest_street2": "string",
"guest_zip": "string",
"id": "string",
"organization_event": {
"event_end": "2019-08-24T14:15:22Z",
"event_metadata": {},
"event_start": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organization": {
"id": "string",
"name": "string"
}
},
"organization_id": "string",
"promo_code": {
"id": "string",
"name": "string"
},
"status": "string",
"survey_responses": [
{
"response": "string",
"survey_question": "string"
}
],
"ticket_definition": {
"id": "string",
"name": "string"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| guest_city | string | false | No description |
| guest_company | string | false | No description |
| guest_country | string | false | No description |
| guest_email | string | false | No description |
| guest_first_name | string | false | No description |
| guest_last_name | string | false | No description |
| guest_phone | string | false | No description |
| guest_salutation | string | false | No description |
| guest_state | string | false | No description |
| guest_street | string | false | No description |
| guest_street2 | string | false | No description |
| guest_zip | string | false | No description |
| id | string | false | No description |
| organization_event | EventIDAndName | false | No description |
| organization_id | string | false | No description |
| promo_code | PromoCodeIDAndName | false | No description |
| status | string | false | No description |
| survey_responses | [SurveyResponse] | false | No description |
| ticket_definition | TicketDefinitionIDAndName | false | No description |
EventRegistrationResponse
{
"result": {
"guest_city": "string",
"guest_company": "string",
"guest_country": "string",
"guest_email": "string",
"guest_first_name": "string",
"guest_last_name": "string",
"guest_phone": "string",
"guest_salutation": "string",
"guest_state": "string",
"guest_street": "string",
"guest_street2": "string",
"guest_zip": "string",
"id": "string",
"organization_event": {
"event_end": "2019-08-24T14:15:22Z",
"event_metadata": {},
"event_start": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organization": {
"id": "string",
"name": "string"
}
},
"organization_id": "string",
"promo_code": {
"id": "string",
"name": "string"
},
"status": "string",
"survey_responses": [
{
"response": "string",
"survey_question": "string"
}
],
"ticket_definition": {
"id": "string",
"name": "string"
}
},
"status": 200
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| result | EventRegistration | false | No description |
| status | integer | false | No description |
EventRegistrationsResponse
{
"result": {
"count": 0,
"items": {
"guest_city": "string",
"guest_company": "string",
"guest_country": "string",
"guest_email": "string",
"guest_first_name": "string",
"guest_last_name": "string",
"guest_phone": "string",
"guest_salutation": "string",
"guest_state": "string",
"guest_street": "string",
"guest_street2": "string",
"guest_zip": "string",
"id": "string",
"organization_event": {
"event_end": "2019-08-24T14:15:22Z",
"event_metadata": {},
"event_start": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organization": {
"id": "string",
"name": "string"
}
},
"organization_id": "string",
"promo_code": {
"id": "string",
"name": "string"
},
"status": "string",
"survey_responses": [
{
"response": "string",
"survey_question": "string"
}
],
"ticket_definition": {
"id": "string",
"name": "string"
}
},
"more": true,
"page": 0,
"total_count": 0
},
"status": 200
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| result | EventRegistrationsResult | false | No description |
| status | integer | false | No description |
EventRegistrationsResult
{
"count": 0,
"items": {
"guest_city": "string",
"guest_company": "string",
"guest_country": "string",
"guest_email": "string",
"guest_first_name": "string",
"guest_last_name": "string",
"guest_phone": "string",
"guest_salutation": "string",
"guest_state": "string",
"guest_street": "string",
"guest_street2": "string",
"guest_zip": "string",
"id": "string",
"organization_event": {
"event_end": "2019-08-24T14:15:22Z",
"event_metadata": {},
"event_start": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organization": {
"id": "string",
"name": "string"
}
},
"organization_id": "string",
"promo_code": {
"id": "string",
"name": "string"
},
"status": "string",
"survey_responses": [
{
"response": "string",
"survey_question": "string"
}
],
"ticket_definition": {
"id": "string",
"name": "string"
}
},
"more": true,
"page": 0,
"total_count": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| count | integer | false | No description |
| items | EventRegistration | false | No description |
| more | boolean | false | No description |
| page | integer | false | No description |
| total_count | integer | false | No description |
Gift
{
"created": "2019-08-24T14:15:22Z",
"description": "string",
"extra_placeholder": "string",
"gift_value": 0,
"id": "string",
"image_url": "string",
"is_disabled": true,
"sku": "string",
"updated": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| created | string(date-time) | false | No description |
| description | string | false | No description |
| extra_placeholder | string | false | No description |
| gift_value | number | false | No description |
| id | string | false | No description |
| image_url | string | false | No description |
| is_disabled | boolean | false | No description |
| sku | string | false | No description |
| updated | string(date-time) | false | No description |
HistoryItem
{
"attribute": "string",
"new_value": {},
"old_value": {},
"reason": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| attribute | string | false | No description |
| new_value | object | false | No description |
| old_value | object | false | No description |
| reason | string | false | No description |
| updated_at | string(date-time) | false | No description |
| user | string | false | No description |
OrganizationDonor
{
"donor": {
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"display_name": "string",
"id": "string"
},
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| donor | Donor | false | No description |
| organization | OrganizationIDAndName | false | No description |
| organization_id | string | false | No description |
OrganizationDonorSchedules
{
"donor": {
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"display_name": "string",
"id": "string"
},
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"schedules": [
{
"amount": "string",
"company_name": "string",
"customer_meta": {},
"designations": [
{
"amount": 0,
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
}
}
],
"donor": {
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"display_name": "string",
"id": "string"
},
"donor_paid_fee": "string",
"expires": "2019-08-24T14:15:22Z",
"history": [
{
"attribute": "string",
"new_value": {},
"old_value": {},
"reason": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": "string"
}
],
"id": "string",
"is_company": true,
"next_payment": "2019-08-24T14:15:22Z",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"reference_code": "string",
"schedule_type": "string",
"start_date": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| donor | Donor | false | No description |
| organization | OrganizationIDAndName | false | No description |
| organization_id | string | false | No description |
| schedules | [RecurringDonationSchedule] | false | No description |
OrganizationIDAndName
{
"id": "string",
"name": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | false | No description |
| name | string | false | No description |
P2PFundraiserResponse
{
"result": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"goal": "string",
"id": "string",
"name": "string",
"organization_id": "string",
"program": {
"description": "string",
"end_date": "2019-08-24T14:15:22Z",
"goal": 0,
"id": "string",
"include_donor_paid_fee": true,
"name": "string",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"status": "string"
},
"program_id": "string",
"status": "string",
"title": "string"
},
"status": 200
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| result | P2pFundraiser | false | No description |
| status | integer | false | No description |
P2PFundraisersResponse
{
"result": {
"count": 0,
"items": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"goal": "string",
"id": "string",
"name": "string",
"organization_id": "string",
"program": {
"description": "string",
"end_date": "2019-08-24T14:15:22Z",
"goal": 0,
"id": "string",
"include_donor_paid_fee": true,
"name": "string",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"status": "string"
},
"program_id": "string",
"status": "string",
"title": "string"
},
"more": true,
"page": 0,
"total_count": 0
},
"status": 200
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| result | P2PFundraisersResult | false | No description |
| status | integer | false | No description |
P2PFundraisersResult
{
"count": 0,
"items": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"goal": "string",
"id": "string",
"name": "string",
"organization_id": "string",
"program": {
"description": "string",
"end_date": "2019-08-24T14:15:22Z",
"goal": 0,
"id": "string",
"include_donor_paid_fee": true,
"name": "string",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"status": "string"
},
"program_id": "string",
"status": "string",
"title": "string"
},
"more": true,
"page": 0,
"total_count": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| count | integer | false | No description |
| items | P2pFundraiser | false | No description |
| more | boolean | false | No description |
| page | integer | false | No description |
| total_count | integer | false | No description |
P2pFundraiser
{
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"goal": "string",
"id": "string",
"name": "string",
"organization_id": "string",
"program": {
"description": "string",
"end_date": "2019-08-24T14:15:22Z",
"goal": 0,
"id": "string",
"include_donor_paid_fee": true,
"name": "string",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"status": "string"
},
"program_id": "string",
"status": "string",
"title": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| created | string(date-time) | false | No description |
| created_by | string | false | No description |
| goal | string | false | No description |
| id | string | false | No description |
| name | string | false | No description |
| organization_id | string | false | No description |
| program | P2pProgram | false | No description |
| program_id | string | false | No description |
| status | string | false | No description |
| title | string | false | No description |
P2pFundraiserMilestone
{
"fundraiser": {
"created": "2019-08-24T14:15:22Z",
"created_by": "string",
"goal": "string",
"id": "string",
"name": "string",
"organization_id": "string",
"program": {
"description": "string",
"end_date": "2019-08-24T14:15:22Z",
"goal": 0,
"id": "string",
"include_donor_paid_fee": true,
"name": "string",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"status": "string"
},
"program_id": "string",
"status": "string",
"title": "string"
},
"milestone": "string",
"organization_id": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| fundraiser | P2pFundraiser | false | No description |
| milestone | string | false | No description |
| organization_id | string | false | No description |
P2pProgram
{
"description": "string",
"end_date": "2019-08-24T14:15:22Z",
"goal": 0,
"id": "string",
"include_donor_paid_fee": true,
"name": "string",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"start_date": "2019-08-24T14:15:22Z",
"status": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| description | string | false | No description |
| end_date | string(date-time) | false | No description |
| goal | number | false | No description |
| id | string | false | No description |
| include_donor_paid_fee | boolean | false | No description |
| name | string | false | No description |
| organization | OrganizationIDAndName | false | No description |
| organization_id | string | false | No description |
| start_date | string(date-time) | false | No description |
| status | string | false | No description |
P2pUpdate
{
"created": "2019-08-24T14:15:22Z",
"fundraiser_id": "string",
"id": "string",
"message": "string",
"organization_id": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| created | string(date-time) | false | No description |
| fundraiser_id | string | false | No description |
| id | string | false | No description |
| message | string | false | No description |
| organization_id | string | false | No description |
PromoCodeIDAndName
{
"id": "string",
"name": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | false | No description |
| name | string | false | No description |
RecurringDonationSchedule
{
"amount": "string",
"company_name": "string",
"customer_meta": {},
"designations": [
{
"amount": 0,
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
}
}
],
"donor": {
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"display_name": "string",
"id": "string"
},
"donor_paid_fee": "string",
"expires": "2019-08-24T14:15:22Z",
"history": [
{
"attribute": "string",
"new_value": {},
"old_value": {},
"reason": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": "string"
}
],
"id": "string",
"is_company": true,
"next_payment": "2019-08-24T14:15:22Z",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"reference_code": "string",
"schedule_type": "string",
"start_date": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| amount | string | false | No description |
| company_name | string | false | No description |
| customer_meta | object | false | No description |
| designations | [DesignatedAmount] | false | No description |
| donor | Donor | false | No description |
| donor_paid_fee | string | false | No description |
| expires | string(date-time) | false | No description |
| history | [HistoryItem] | false | No description |
| id | string | false | No description |
| is_company | boolean | false | No description |
| next_payment | string(date-time) | false | No description |
| organization | OrganizationIDAndName | false | No description |
| organization_id | string | false | No description |
| payment_gateway_id | string | false | No description |
| payment_gateway_name | string | false | No description |
| reference_code | string | false | No description |
| schedule_type | string | false | No description |
| start_date | string(date-time) | false | No description |
| updated | string(date-time) | false | No description |
RecurringDonationScheduleCancelled
{
"organization_id": "string",
"reason": "string",
"schedule": {
"amount": "string",
"company_name": "string",
"customer_meta": {},
"designations": [
{
"amount": 0,
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
}
}
],
"donor": {
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"display_name": "string",
"id": "string"
},
"donor_paid_fee": "string",
"expires": "2019-08-24T14:15:22Z",
"history": [
{
"attribute": "string",
"new_value": {},
"old_value": {},
"reason": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": "string"
}
],
"id": "string",
"is_company": true,
"next_payment": "2019-08-24T14:15:22Z",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"reference_code": "string",
"schedule_type": "string",
"start_date": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| organization_id | string | false | No description |
| reason | string | false | No description |
| schedule | RecurringDonationSchedule | false | No description |
RecurringScheduleResponse
{
"result": {
"amount": "string",
"company_name": "string",
"customer_meta": {},
"designations": [
{
"amount": 0,
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
}
}
],
"donor": {
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"display_name": "string",
"id": "string"
},
"donor_paid_fee": "string",
"expires": "2019-08-24T14:15:22Z",
"history": [
{
"attribute": "string",
"new_value": {},
"old_value": {},
"reason": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": "string"
}
],
"id": "string",
"is_company": true,
"next_payment": "2019-08-24T14:15:22Z",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"reference_code": "string",
"schedule_type": "string",
"start_date": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
},
"status": 200
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| result | RecurringDonationSchedule | false | No description |
| status | integer | false | No description |
RecurringSchedulesResponse
{
"result": {
"count": 0,
"items": {
"amount": "string",
"company_name": "string",
"customer_meta": {},
"designations": [
{
"amount": 0,
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
}
}
],
"donor": {
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"display_name": "string",
"id": "string"
},
"donor_paid_fee": "string",
"expires": "2019-08-24T14:15:22Z",
"history": [
{
"attribute": "string",
"new_value": {},
"old_value": {},
"reason": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": "string"
}
],
"id": "string",
"is_company": true,
"next_payment": "2019-08-24T14:15:22Z",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"reference_code": "string",
"schedule_type": "string",
"start_date": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
},
"more": true,
"page": 0,
"total_count": 0
},
"status": 200
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| result | RecurringSchedulesResult | false | No description |
| status | integer | false | No description |
RecurringSchedulesResult
{
"count": 0,
"items": {
"amount": "string",
"company_name": "string",
"customer_meta": {},
"designations": [
{
"amount": 0,
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
}
}
],
"donor": {
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"display_name": "string",
"id": "string"
},
"donor_paid_fee": "string",
"expires": "2019-08-24T14:15:22Z",
"history": [
{
"attribute": "string",
"new_value": {},
"old_value": {},
"reason": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": "string"
}
],
"id": "string",
"is_company": true,
"next_payment": "2019-08-24T14:15:22Z",
"organization": {
"id": "string",
"name": "string"
},
"organization_id": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"reference_code": "string",
"schedule_type": "string",
"start_date": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
},
"more": true,
"page": 0,
"total_count": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| count | integer | false | No description |
| items | RecurringDonationSchedule | false | No description |
| more | boolean | false | No description |
| page | integer | false | No description |
| total_count | integer | false | No description |
SurveyResponse
{
"response": "string",
"survey_question": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| response | string | false | No description |
| survey_question | string | false | No description |
TicketDefinitionIDAndName
{
"id": "string",
"name": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | false | No description |
| name | string | false | No description |
Transaction
{
"additional_info": "string",
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"advocacy_program_id": "string",
"advocacy_program_name": "string",
"advocacy_team_id": "string",
"advocacy_team_name": "string",
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"advocate_id": "string",
"advocate_name": "string",
"campaign_id": "string",
"campaign_title": "string",
"card_type": "string",
"check_number": "string",
"client_proceeds": 0,
"company_name": "string",
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"corporate_matching_record": {
"company_name": "string",
"donation_id": 0,
"matched_transaction_id": "string"
},
"created": "2019-08-24T14:15:22Z",
"custom_note_1": "string",
"custom_note_2": "string",
"custom_note_3": "string",
"custom_note_4": "string",
"custom_note_5": "string",
"customer_meta": {},
"description": "string",
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
},
"designation_note": "string",
"donor_id": "string",
"donor_paid_fee": 0,
"email_opt_in": true,
"embed": {
"id": "string",
"name": "string"
},
"expiration_month": 0,
"expiration_year": 0,
"external_tracking_id": "string",
"final_date": "2019-08-24T14:15:22Z",
"frequency": "string",
"gift": {
"created": "2019-08-24T14:15:22Z",
"description": "string",
"extra_placeholder": "string",
"gift_value": 0,
"id": "string",
"image_url": "string",
"is_disabled": true,
"sku": "string",
"updated": "2019-08-24T14:15:22Z"
},
"gift_extra": "string",
"hide_name": true,
"id": "string",
"last_four_digits": "string",
"net_proceeds": 0,
"organization_event_id": "string",
"organization_id": "string",
"p2p_fundraiser_id": "string",
"p2p_fundraiser_name": "string",
"p2p_fundraiser_title": "string",
"p2p_program_id": "string",
"p2p_program_name": "string",
"p2p_team_id": "string",
"p2p_team_name": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"payment_transaction_id": "string",
"recurring_count": 0,
"reference_code": "string",
"sale_price": 0,
"schedule_id": "string",
"sms_keyword": "string",
"status": "string",
"subtype": "string",
"transaction_set_id": "string",
"tribute": {
"definition": {
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
},
"from_name": "string",
"honorees": [
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
],
"include_amount": true,
"recipient": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"send_card": true
},
"type": "string",
"utm": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string"
},
"vendor_id": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| additional_info | string | false | No description |
| address | Address | false | No description |
| advocacy_program_id | string | false | No description |
| advocacy_program_name | string | false | No description |
| advocacy_team_id | string | false | No description |
| advocacy_team_name | string | false | No description |
| advocate | Advocate | false | No description |
| advocate_id | string | false | No description |
| advocate_name | string | false | No description |
| campaign_id | string | false | No description |
| campaign_title | string | false | No description |
| card_type | string | false | No description |
| check_number | string | false | No description |
| client_proceeds | number | false | No description |
| company_name | string | false | No description |
| contact | Contact | false | No description |
| corporate_matching_record | CorporateMatchingRecord | false | No description |
| created | string(date-time) | false | No description |
| custom_note_1 | string | false | No description |
| custom_note_2 | string | false | No description |
| custom_note_3 | string | false | No description |
| custom_note_4 | string | false | No description |
| custom_note_5 | string | false | No description |
| customer_meta | object | false | No description |
| description | string | false | No description |
| designation | Designation | false | No description |
| designation_note | string | false | No description |
| donor_id | string | false | No description |
| donor_paid_fee | number | false | No description |
| email_opt_in | boolean | false | No description |
| embed | Embed | false | No description |
| expiration_month | integer | false | No description |
| expiration_year | integer | false | No description |
| external_tracking_id | string | false | No description |
| final_date | string(date-time) | false | No description |
| frequency | string | false | No description |
| gift | Gift | false | No description |
| gift_extra | string | false | No description |
| hide_name | boolean | false | No description |
| id | string | false | No description |
| last_four_digits | string | false | No description |
| net_proceeds | number | false | No description |
| organization_event_id | string | false | No description |
| organization_id | string | false | No description |
| p2p_fundraiser_id | string | false | No description |
| p2p_fundraiser_name | string | false | No description |
| p2p_fundraiser_title | string | false | No description |
| p2p_program_id | string | false | No description |
| p2p_program_name | string | false | No description |
| p2p_team_id | string | false | No description |
| p2p_team_name | string | false | No description |
| payment_gateway_id | string | false | No description |
| payment_gateway_name | string | false | No description |
| payment_transaction_id | string | false | No description |
| recurring_count | integer | false | No description |
| reference_code | string | false | No description |
| sale_price | number | false | No description |
| schedule_id | string | false | No description |
| sms_keyword | string | false | No description |
| status | string | false | No description |
| subtype | string | false | No description |
| transaction_set_id | string | false | No description |
| tribute | Tribute | false | No description |
| type | string | false | No description |
| utm | TransactionUtm | false | No description |
| vendor_id | integer | false | No description |
TransactionHonoree
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| firstname | string | false | No description |
| lastname | string | false | No description |
| message | string | false | No description |
TransactionResponse
{
"result": {
"additional_info": "string",
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"advocacy_program_id": "string",
"advocacy_program_name": "string",
"advocacy_team_id": "string",
"advocacy_team_name": "string",
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"advocate_id": "string",
"advocate_name": "string",
"campaign_id": "string",
"campaign_title": "string",
"card_type": "string",
"check_number": "string",
"client_proceeds": 0,
"company_name": "string",
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"corporate_matching_record": {
"company_name": "string",
"donation_id": 0,
"matched_transaction_id": "string"
},
"created": "2019-08-24T14:15:22Z",
"custom_note_1": "string",
"custom_note_2": "string",
"custom_note_3": "string",
"custom_note_4": "string",
"custom_note_5": "string",
"customer_meta": {},
"description": "string",
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
},
"designation_note": "string",
"donor_id": "string",
"donor_paid_fee": 0,
"email_opt_in": true,
"embed": {
"id": "string",
"name": "string"
},
"expiration_month": 0,
"expiration_year": 0,
"external_tracking_id": "string",
"final_date": "2019-08-24T14:15:22Z",
"frequency": "string",
"gift": {
"created": "2019-08-24T14:15:22Z",
"description": "string",
"extra_placeholder": "string",
"gift_value": 0,
"id": "string",
"image_url": "string",
"is_disabled": true,
"sku": "string",
"updated": "2019-08-24T14:15:22Z"
},
"gift_extra": "string",
"hide_name": true,
"id": "string",
"last_four_digits": "string",
"net_proceeds": 0,
"organization_event_id": "string",
"organization_id": "string",
"p2p_fundraiser_id": "string",
"p2p_fundraiser_name": "string",
"p2p_fundraiser_title": "string",
"p2p_program_id": "string",
"p2p_program_name": "string",
"p2p_team_id": "string",
"p2p_team_name": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"payment_transaction_id": "string",
"recurring_count": 0,
"reference_code": "string",
"sale_price": 0,
"schedule_id": "string",
"sms_keyword": "string",
"status": "string",
"subtype": "string",
"transaction_set_id": "string",
"tribute": {
"definition": {
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
},
"from_name": "string",
"honorees": [
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
],
"include_amount": true,
"recipient": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"send_card": true
},
"type": "string",
"utm": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string"
},
"vendor_id": 0
},
"status": 200
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| result | Transaction | false | No description |
| status | integer | false | No description |
TransactionSet
{
"created": "2019-08-24T14:15:22Z",
"id": "string",
"organization_id": "string",
"transactions": [
{
"additional_info": "string",
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"advocacy_program_id": "string",
"advocacy_program_name": "string",
"advocacy_team_id": "string",
"advocacy_team_name": "string",
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"advocate_id": "string",
"advocate_name": "string",
"campaign_id": "string",
"campaign_title": "string",
"card_type": "string",
"check_number": "string",
"client_proceeds": 0,
"company_name": "string",
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"corporate_matching_record": {
"company_name": "string",
"donation_id": 0,
"matched_transaction_id": "string"
},
"created": "2019-08-24T14:15:22Z",
"custom_note_1": "string",
"custom_note_2": "string",
"custom_note_3": "string",
"custom_note_4": "string",
"custom_note_5": "string",
"customer_meta": {},
"description": "string",
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
},
"designation_note": "string",
"donor_id": "string",
"donor_paid_fee": 0,
"email_opt_in": true,
"embed": {
"id": "string",
"name": "string"
},
"expiration_month": 0,
"expiration_year": 0,
"external_tracking_id": "string",
"final_date": "2019-08-24T14:15:22Z",
"frequency": "string",
"gift": {
"created": "2019-08-24T14:15:22Z",
"description": "string",
"extra_placeholder": "string",
"gift_value": 0,
"id": "string",
"image_url": "string",
"is_disabled": true,
"sku": "string",
"updated": "2019-08-24T14:15:22Z"
},
"gift_extra": "string",
"hide_name": true,
"id": "string",
"last_four_digits": "string",
"net_proceeds": 0,
"organization_event_id": "string",
"organization_id": "string",
"p2p_fundraiser_id": "string",
"p2p_fundraiser_name": "string",
"p2p_fundraiser_title": "string",
"p2p_program_id": "string",
"p2p_program_name": "string",
"p2p_team_id": "string",
"p2p_team_name": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"payment_transaction_id": "string",
"recurring_count": 0,
"reference_code": "string",
"sale_price": 0,
"schedule_id": "string",
"sms_keyword": "string",
"status": "string",
"subtype": "string",
"transaction_set_id": "string",
"tribute": {
"definition": {
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
},
"from_name": "string",
"honorees": [
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
],
"include_amount": true,
"recipient": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"send_card": true
},
"type": "string",
"utm": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string"
},
"vendor_id": 0
}
]
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| created | string(date-time) | false | No description |
| id | string | false | No description |
| organization_id | string | false | No description |
| transactions | [Transaction] | false | No description |
TransactionSetResponse
{
"result": {
"created": "2019-08-24T14:15:22Z",
"id": "string",
"organization_id": "string",
"transactions": [
{
"additional_info": "string",
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"advocacy_program_id": "string",
"advocacy_program_name": "string",
"advocacy_team_id": "string",
"advocacy_team_name": "string",
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"advocate_id": "string",
"advocate_name": "string",
"campaign_id": "string",
"campaign_title": "string",
"card_type": "string",
"check_number": "string",
"client_proceeds": 0,
"company_name": "string",
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"corporate_matching_record": {
"company_name": "string",
"donation_id": 0,
"matched_transaction_id": "string"
},
"created": "2019-08-24T14:15:22Z",
"custom_note_1": "string",
"custom_note_2": "string",
"custom_note_3": "string",
"custom_note_4": "string",
"custom_note_5": "string",
"customer_meta": {},
"description": "string",
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
},
"designation_note": "string",
"donor_id": "string",
"donor_paid_fee": 0,
"email_opt_in": true,
"embed": {
"id": "string",
"name": "string"
},
"expiration_month": 0,
"expiration_year": 0,
"external_tracking_id": "string",
"final_date": "2019-08-24T14:15:22Z",
"frequency": "string",
"gift": {
"created": "2019-08-24T14:15:22Z",
"description": "string",
"extra_placeholder": "string",
"gift_value": 0,
"id": "string",
"image_url": "string",
"is_disabled": true,
"sku": "string",
"updated": "2019-08-24T14:15:22Z"
},
"gift_extra": "string",
"hide_name": true,
"id": "string",
"last_four_digits": "string",
"net_proceeds": 0,
"organization_event_id": "string",
"organization_id": "string",
"p2p_fundraiser_id": "string",
"p2p_fundraiser_name": "string",
"p2p_fundraiser_title": "string",
"p2p_program_id": "string",
"p2p_program_name": "string",
"p2p_team_id": "string",
"p2p_team_name": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"payment_transaction_id": "string",
"recurring_count": 0,
"reference_code": "string",
"sale_price": 0,
"schedule_id": "string",
"sms_keyword": "string",
"status": "string",
"subtype": "string",
"transaction_set_id": "string",
"tribute": {
"definition": {
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
},
"from_name": "string",
"honorees": [
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
],
"include_amount": true,
"recipient": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"send_card": true
},
"type": "string",
"utm": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string"
},
"vendor_id": 0
}
]
},
"status": 200
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| result | TransactionSet | false | No description |
| status | integer | false | No description |
TransactionSetsResponse
{
"result": {
"count": 0,
"items": [
{
"created": "2019-08-24T14:15:22Z",
"id": "string",
"organization_id": "string",
"transactions": [
{
"additional_info": "string",
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"advocacy_program_id": "string",
"advocacy_program_name": "string",
"advocacy_team_id": "string",
"advocacy_team_name": "string",
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"advocate_id": "string",
"advocate_name": "string",
"campaign_id": "string",
"campaign_title": "string",
"card_type": "string",
"check_number": "string",
"client_proceeds": 0,
"company_name": "string",
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"corporate_matching_record": {
"company_name": "string",
"donation_id": 0,
"matched_transaction_id": "string"
},
"created": "2019-08-24T14:15:22Z",
"custom_note_1": "string",
"custom_note_2": "string",
"custom_note_3": "string",
"custom_note_4": "string",
"custom_note_5": "string",
"customer_meta": {},
"description": "string",
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
},
"designation_note": "string",
"donor_id": "string",
"donor_paid_fee": 0,
"email_opt_in": true,
"embed": {
"id": "string",
"name": "string"
},
"expiration_month": 0,
"expiration_year": 0,
"external_tracking_id": "string",
"final_date": "2019-08-24T14:15:22Z",
"frequency": "string",
"gift": {
"created": "2019-08-24T14:15:22Z",
"description": "string",
"extra_placeholder": "string",
"gift_value": 0,
"id": "string",
"image_url": "string",
"is_disabled": true,
"sku": "string",
"updated": "2019-08-24T14:15:22Z"
},
"gift_extra": "string",
"hide_name": true,
"id": "string",
"last_four_digits": "string",
"net_proceeds": 0,
"organization_event_id": "string",
"organization_id": "string",
"p2p_fundraiser_id": "string",
"p2p_fundraiser_name": "string",
"p2p_fundraiser_title": "string",
"p2p_program_id": "string",
"p2p_program_name": "string",
"p2p_team_id": "string",
"p2p_team_name": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"payment_transaction_id": "string",
"recurring_count": 0,
"reference_code": "string",
"sale_price": 0,
"schedule_id": "string",
"sms_keyword": "string",
"status": "string",
"subtype": "string",
"transaction_set_id": "string",
"tribute": {
"definition": {
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
},
"from_name": "string",
"honorees": [
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
],
"include_amount": true,
"recipient": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"send_card": true
},
"type": "string",
"utm": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string"
},
"vendor_id": 0
}
]
}
],
"more": true,
"page": 0,
"total_count": 0
},
"status": 200
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| result | TransactionSetsResult | false | No description |
| status | integer | false | No description |
TransactionSetsResult
{
"count": 0,
"items": [
{
"created": "2019-08-24T14:15:22Z",
"id": "string",
"organization_id": "string",
"transactions": [
{
"additional_info": "string",
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"advocacy_program_id": "string",
"advocacy_program_name": "string",
"advocacy_team_id": "string",
"advocacy_team_name": "string",
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"advocate_id": "string",
"advocate_name": "string",
"campaign_id": "string",
"campaign_title": "string",
"card_type": "string",
"check_number": "string",
"client_proceeds": 0,
"company_name": "string",
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"corporate_matching_record": {
"company_name": "string",
"donation_id": 0,
"matched_transaction_id": "string"
},
"created": "2019-08-24T14:15:22Z",
"custom_note_1": "string",
"custom_note_2": "string",
"custom_note_3": "string",
"custom_note_4": "string",
"custom_note_5": "string",
"customer_meta": {},
"description": "string",
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
},
"designation_note": "string",
"donor_id": "string",
"donor_paid_fee": 0,
"email_opt_in": true,
"embed": {
"id": "string",
"name": "string"
},
"expiration_month": 0,
"expiration_year": 0,
"external_tracking_id": "string",
"final_date": "2019-08-24T14:15:22Z",
"frequency": "string",
"gift": {
"created": "2019-08-24T14:15:22Z",
"description": "string",
"extra_placeholder": "string",
"gift_value": 0,
"id": "string",
"image_url": "string",
"is_disabled": true,
"sku": "string",
"updated": "2019-08-24T14:15:22Z"
},
"gift_extra": "string",
"hide_name": true,
"id": "string",
"last_four_digits": "string",
"net_proceeds": 0,
"organization_event_id": "string",
"organization_id": "string",
"p2p_fundraiser_id": "string",
"p2p_fundraiser_name": "string",
"p2p_fundraiser_title": "string",
"p2p_program_id": "string",
"p2p_program_name": "string",
"p2p_team_id": "string",
"p2p_team_name": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"payment_transaction_id": "string",
"recurring_count": 0,
"reference_code": "string",
"sale_price": 0,
"schedule_id": "string",
"sms_keyword": "string",
"status": "string",
"subtype": "string",
"transaction_set_id": "string",
"tribute": {
"definition": {
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
},
"from_name": "string",
"honorees": [
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
],
"include_amount": true,
"recipient": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"send_card": true
},
"type": "string",
"utm": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string"
},
"vendor_id": 0
}
]
}
],
"more": true,
"page": 0,
"total_count": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| count | integer | false | No description |
| items | [TransactionSet] | false | No description |
| more | boolean | false | No description |
| page | integer | false | No description |
| total_count | integer | false | No description |
TransactionUtm
{
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string"
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| campaign | string | false | No description |
| content | string | false | No description |
| medium | string | false | No description |
| source | string | false | No description |
| term | string | false | No description |
TransactionsResponse
{
"result": {
"count": 0,
"items": [
{
"additional_info": "string",
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"advocacy_program_id": "string",
"advocacy_program_name": "string",
"advocacy_team_id": "string",
"advocacy_team_name": "string",
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"advocate_id": "string",
"advocate_name": "string",
"campaign_id": "string",
"campaign_title": "string",
"card_type": "string",
"check_number": "string",
"client_proceeds": 0,
"company_name": "string",
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"corporate_matching_record": {
"company_name": "string",
"donation_id": 0,
"matched_transaction_id": "string"
},
"created": "2019-08-24T14:15:22Z",
"custom_note_1": "string",
"custom_note_2": "string",
"custom_note_3": "string",
"custom_note_4": "string",
"custom_note_5": "string",
"customer_meta": {},
"description": "string",
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
},
"designation_note": "string",
"donor_id": "string",
"donor_paid_fee": 0,
"email_opt_in": true,
"embed": {
"id": "string",
"name": "string"
},
"expiration_month": 0,
"expiration_year": 0,
"external_tracking_id": "string",
"final_date": "2019-08-24T14:15:22Z",
"frequency": "string",
"gift": {
"created": "2019-08-24T14:15:22Z",
"description": "string",
"extra_placeholder": "string",
"gift_value": 0,
"id": "string",
"image_url": "string",
"is_disabled": true,
"sku": "string",
"updated": "2019-08-24T14:15:22Z"
},
"gift_extra": "string",
"hide_name": true,
"id": "string",
"last_four_digits": "string",
"net_proceeds": 0,
"organization_event_id": "string",
"organization_id": "string",
"p2p_fundraiser_id": "string",
"p2p_fundraiser_name": "string",
"p2p_fundraiser_title": "string",
"p2p_program_id": "string",
"p2p_program_name": "string",
"p2p_team_id": "string",
"p2p_team_name": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"payment_transaction_id": "string",
"recurring_count": 0,
"reference_code": "string",
"sale_price": 0,
"schedule_id": "string",
"sms_keyword": "string",
"status": "string",
"subtype": "string",
"transaction_set_id": "string",
"tribute": {
"definition": {
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
},
"from_name": "string",
"honorees": [
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
],
"include_amount": true,
"recipient": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"send_card": true
},
"type": "string",
"utm": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string"
},
"vendor_id": 0
}
],
"more": true,
"page": 0,
"total_count": 0
},
"status": 200
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| result | TransactionsResult | false | No description |
| status | integer | false | No description |
TransactionsResult
{
"count": 0,
"items": [
{
"additional_info": "string",
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"advocacy_program_id": "string",
"advocacy_program_name": "string",
"advocacy_team_id": "string",
"advocacy_team_name": "string",
"advocate": {
"address": {
"city": "string",
"country": "string",
"state": "string",
"street": "string",
"street2": "string",
"zip_code": "string"
},
"email": "string",
"first_name": "string",
"id": "string",
"join_date": "2019-08-24T14:15:22Z",
"last_name": "string",
"phone": "string"
},
"advocate_id": "string",
"advocate_name": "string",
"campaign_id": "string",
"campaign_title": "string",
"card_type": "string",
"check_number": "string",
"client_proceeds": 0,
"company_name": "string",
"contact": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"corporate_matching_record": {
"company_name": "string",
"donation_id": 0,
"matched_transaction_id": "string"
},
"created": "2019-08-24T14:15:22Z",
"custom_note_1": "string",
"custom_note_2": "string",
"custom_note_3": "string",
"custom_note_4": "string",
"custom_note_5": "string",
"customer_meta": {},
"description": "string",
"designation": {
"code": "string",
"fund_id": "string",
"id": "string",
"title": "string"
},
"designation_note": "string",
"donor_id": "string",
"donor_paid_fee": 0,
"email_opt_in": true,
"embed": {
"id": "string",
"name": "string"
},
"expiration_month": 0,
"expiration_year": 0,
"external_tracking_id": "string",
"final_date": "2019-08-24T14:15:22Z",
"frequency": "string",
"gift": {
"created": "2019-08-24T14:15:22Z",
"description": "string",
"extra_placeholder": "string",
"gift_value": 0,
"id": "string",
"image_url": "string",
"is_disabled": true,
"sku": "string",
"updated": "2019-08-24T14:15:22Z"
},
"gift_extra": "string",
"hide_name": true,
"id": "string",
"last_four_digits": "string",
"net_proceeds": 0,
"organization_event_id": "string",
"organization_id": "string",
"p2p_fundraiser_id": "string",
"p2p_fundraiser_name": "string",
"p2p_fundraiser_title": "string",
"p2p_program_id": "string",
"p2p_program_name": "string",
"p2p_team_id": "string",
"p2p_team_name": "string",
"payment_gateway_id": "string",
"payment_gateway_name": "string",
"payment_transaction_id": "string",
"recurring_count": 0,
"reference_code": "string",
"sale_price": 0,
"schedule_id": "string",
"sms_keyword": "string",
"status": "string",
"subtype": "string",
"transaction_set_id": "string",
"tribute": {
"definition": {
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
},
"from_name": "string",
"honorees": [
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
],
"include_amount": true,
"recipient": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"send_card": true
},
"type": "string",
"utm": {
"campaign": "string",
"content": "string",
"medium": "string",
"source": "string",
"term": "string"
},
"vendor_id": 0
}
],
"more": true,
"page": 0,
"total_count": 0
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| count | integer | false | No description |
| items | [Transaction] | false | No description |
| more | boolean | false | No description |
| page | integer | false | No description |
| total_count | integer | false | No description |
Tribute
{
"definition": {
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
},
"from_name": "string",
"honorees": [
{
"firstname": "string",
"lastname": "string",
"message": "string"
}
],
"include_amount": true,
"recipient": {
"address": {
"city": "string",
"country": "string",
"country_code": "string",
"country_name": "string",
"state": "string",
"street": "string",
"street2": "string",
"title": "string",
"zip": "string"
},
"created": "2019-08-24T14:15:22Z",
"email": "string",
"firstname": "string",
"lastname": "string",
"middlename": "string",
"phone": "string",
"timezone": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z"
},
"send_card": true
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| definition | TributeDefinition | false | No description |
| from_name | string | false | No description |
| honorees | [TransactionHonoree] | false | No description |
| include_amount | boolean | false | No description |
| recipient | Contact | false | No description |
| send_card | boolean | false | No description |
TributeDefinition
{
"description": "string",
"id": "string",
"image_key": "string",
"image_url": "string",
"is_disabled": true,
"recipient_address_required": true,
"recipient_email_required": true
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| description | string | false | No description |
| id | string | false | No description |
| image_key | string | false | No description |
| image_url | string | false | No description |
| is_disabled | boolean | false | No description |
| recipient_address_required | boolean | false | No description |
| recipient_email_required | boolean | false | No description |