Givebutter (Independent Publisher) (Preview)

Givebutter is the world’s first completely free end-to-end fundraising platform. Raise more with modern forms, campaigns, and events. Manage your contacts and funds with details about transactions, payouts, and funds.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Connector Metadata
Publisher	Troy Taylor, Hitachi Solutions
Website	https://givebutter.com/
Privacy policy	https://givebutter.com/privacy
Categories	Finance

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
API Key (in the format 'Bearer APIKey')	securestring	The API Key (in the format 'Bearer APIKey') for this api	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Archive a contact	Deletes a contact.
Create a campaign	Creates a new campaign.
Create a contact	Creates a new contact.
Create a fund	Creates a new fund.
Delete a campaign	Deletes a specific campaign
Delete a fund	Deletes a specific fund.
Delete a member	Deletes a member from a campaign.
Get a campaign	Retrieves a specific campaign.
Get a contact	Retrieves a specific contact.
Get a fund	Retrieves a specific fund.
Get a member	Retrieves a specific member.
Get a payout	Retrieves a specific payout
Get a plan	Retrieves a specific plan.
Get a team	Retrieves a specific team.
Get a ticket	Retrieves a specific ticket.
Get a transaction	Retrieves a specific transaction.
Get campaigns	Retrieves a list of your campaigns.
Get contacts	Retrieves a list of contacts.
Get funds	Retrieves a list of funds.
Get members	Retrieves a list of the members of a specific campaign.
Get payouts	Retrieves a list of payouts
Get plans	Retrieves a list of plans
Get teams	Retrieves a list of the teams under a specific campaign.
Get tickets	Retrieve a list of your tickets.
Get transactions	Retrieves a list of transactions
Restore a contact	Restores a deleted contact
Update a campaign	Updates an existing campaign.
Update a contact	Updates a specific contact.
Update a fund	Updates a specific fund.

Archive a contact

Operation ID:

ContactDelete

Deletes a contact.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.

Returns

response

string

Create a campaign

Operation ID:

CampaignPost

Creates a new campaign.

Parameters

Name	Key	Required	Type	Description
Description	description		string	The description.
End At	end_at		string	When the end is at.
Goal	goal		integer	The goal.
Subtitle	subtitle		string	The subtitle.
Slug	slug		string	The slug.
Title	title		string	The title.
Type	type		string	The type.

Returns

Name	Path	Type	Description
ID	id	integer	The unique identifier.
Account ID	account_id	string	The account unique identifier.
Type	type	string	The type.
Title	title	string	The title.
Subtitle	subtitle	string	The subtitle.
Description	description	string	The description.
Slug	slug	string	The slug.
URL	url	string	The URL address.
Goal	goal	integer	The goal.
Raised	raised	integer	The amount raised.
Donors	donors	integer	The number of donors.
Currency	currency	string	The currency.
Logo	logo	string	The logo.
Type	cover.type	string	The type.
URL	cover.url	string	The URL address.
Source	cover.source	string	The source.
End At	end_at	string	When the end is at.
Created At	created_at	string	The created at.
Updated At	updated_at	string	The last updated at.

Create a contact

Operation ID:

ContactPost

Creates a new contact.

Parameters

Name	Key	Required	Type	Description
First Name	first_name		string	The first name.
Middle Name	middle_name		string	The middle name.
Last Name	last_name		string	The last name.
Value	value		string	The value.
Type	type		string	The type.
Value	value		string	The value.
Type	type		string	The type.
Address	address_1		string	The address.
Address Line 2	address_2		string	The address line 2.
City	city		string	The city.
State	state		string	The state.
Zipcode	zipcode		string	The zipcode.
Country	country		string	The country.
Tags	tags		array of string
DOB	dob		string	The date of birth.
Company	company		string	The company.
Title	title		string	The title.
Twitter URL	twitter_url		string	The Twitter URL address.
LinkedIn URL	linkedin_url		string	The LinkedIn URL address.
Facebook URL	facebook_url		string	The Facebook URL address.

Returns

Name	Path	Type	Description
ID	id	integer	The unique identifier.
First Name	first_name	string	The first name.
Middle Name	middle_name	string	The middle name.
Last Name	last_name	string	The last name.
DOB	dob	string	The date of birth.
Company	company	string	The company.
Title	title	string	The title.
Twitter URL	twitter_url	string	The Twitter URL address.
LinkedIn URL	linkedin_url	string	The LinkedIn URL address.
Facebook URL	facebook_url	string	The Facebook URL address.
Emails	emails	array of object
Type	emails.type	string	The type.
Value	emails.value	string	The value.
Phones	phones	array of object
Type	phones.type	string	The type.
Value	phones.value	string	The value.
Primary Email	primary_email	string	The primary email address.
Primary Phone	primary_phone	string	The primary phone number.
Note	note	string	The note.
Addresses	addresses	array of object
Address	addresses.address_1	string	The address.
Address Line 2	addresses.address_2	string	The address line 2.
City	addresses.city	string	The city.
State	addresses.state	string	The state.
Zipcode	addresses.zipcode	string	The zipcode.
Country	addresses.country	string	The country.
Type	addresses.type	string	The type.
Is Primary	addresses.is_primary	integer	The is primary.
Created At	addresses.created_at	string	The created at.
Updated At	addresses.updated_at	string	The last updated at.
Address	primary_address.address_1	string	The address.
Address Line 2	primary_address.address_2	string	The address line 2.
City	primary_address.city	string	The city.
State	primary_address.state	string	The state.
Zipcode	primary_address.zipcode	string	The zipcode.
Country	primary_address.country	string	The country.
Type	primary_address.type	string	The type.
Is Primary	primary_address.is_primary	integer	The is primary.
Created At	primary_address.created_at	string	When created at.
Updated At	primary_address.updated_at	string	When last updated at.
Recurring Contributions	stats.recurring_contributions	integer	The number of recurring contributions.
Total Contributions	stats.total_contributions	integer	The total number of contributions.
Tags	tags	array of string	The tags.
Custom Fields	custom_fields	array of	The custom fields.
Archived At	archived_at	string	When archived at.
Created At	created_at	string	The created at.
Updated At	updated_at	string	The last updated at.

Create a fund

Operation ID:

FundPost

Creates a new fund.

Parameters

Name	Key	Required	Type	Description
Name	name		string	The name.
Code	code		string	The code.

Returns

Name	Path	Type	Description
ID	id	string	The unique identifier.
Code	code	string	The code.
Name	name	string	The name.
Raised	raised	integer	The amount raised.
Supporters	supporters	integer	The number of supporters.
Created At	created_at	string	The created at.
Updated At	updated_at	string	The last updated at.

Delete a campaign

Operation ID:

CampaignDelete

Deletes a specific campaign

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.

Returns

response

string

Delete a fund

Operation ID:

FundDelete

Deletes a specific fund.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.

Returns

response

string

Delete a member

Operation ID:

MemberDelete

Deletes a member from a campaign.

Parameters

Name	Key	Required	Type	Description
Campaign ID	campaign_id	True	string	The campaign unique identifier.
Member ID	member_id	True	string	The member unique identifier.

Returns

response

string

Get a campaign

Operation ID:

CampaignGetA

Retrieves a specific campaign.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.

Returns

Name	Path	Type	Description
ID	id	integer	The unique identifier.
Account ID	account_id	string	The account unique identifier.
Type	type	string	The type.
Title	title	string	The title.
Subtitle	subtitle	string	The subtitle.
Description	description	string	The description.
Slug	slug	string	The slug.
URL	url	string	The URL address.
Goal	goal	integer	The goal.
Raised	raised	integer	The amount raised.
Donors	donors	integer	The number of donors.
Currency	currency	string	The currency.
Logo	logo	string	The logo.
Type	cover.type	string	The type.
URL	cover.url	string	The URL address.
Source	cover.source	string	The source.
End At	end_at	string	When the end is at.
Created At	created_at	string	The created at.
Updated At	updated_at	string	The last updated at.
Title	event.title	string	The title.
Type	event.type	string	The type.
Location Name	event.location_name	string	The location name.
Address Formatted	event.address_formatted	string	The formatted address.
Google Place ID	event.google_place_id	string	The Google Place unique identifier.
Start At	event.start_at	string	When started at.
End At	event.end_at	string	The end at.
Timezone	event.timezone	string	The timezone.
Details	event.details	string	The details.
Private	event.private	boolean	Whether private.
Tickets Required	event.tickets_required	boolean	Whether tickets are required.
URL	event.livestream.url	string	The URL address.
Type	event.livestream.type	string	The type.
Location	event.livestream.location	string	The location.
Platform	event.livestream.platform	string	The platform.
Embed URL	event.livestream.embed_url	string	The embed URL address.
Scheduled	event.livestream.scheduled	boolean	Whether scheduled.
Livestream Start At	event.livestream_start_at	string	The livestream starts at.
Livestream End At	event.livestream_end_at	string	The livestream ends at.

Get a contact

Operation ID:

ContactGetA

Retrieves a specific contact.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.

Returns

Name	Path	Type	Description
ID	id	integer	The unique identifier.
First Name	first_name	string	The first name.
Middle Name	middle_name	string	The middle name.
Last Name	last_name	string	The last name.
DOB	dob	string	The date of birth.
Company	company	string	The company.
Title	title	string	The title.
Twitter URL	twitter_url	string	The Twitter URL address.
LinkedIn URL	linkedin_url	string	The LinkedIn URL address.
Facebook URL	facebook_url	string	The Facebook URL address.
Emails	emails	array of object
Type	emails.type	string	The type.
Value	emails.value	string	The value.
Phones	phones	array of object
Type	phones.type	string	The type.
Value	phones.value	string	The value.
Primary Email	primary_email	string	The primary email address.
Primary Phone	primary_phone	string	The primary phone number.
Note	note	string	The note.
Addresses	addresses	array of object
Address	addresses.address_1	string	The address.
Address Line 2	addresses.address_2	string	The address line 2.
City	addresses.city	string	The city.
State	addresses.state	string	The state.
Zipcode	addresses.zipcode	string	The zipcode.
Country	addresses.country	string	The country.
Type	addresses.type	string	The type.
Is Primary	addresses.is_primary	integer	The is primary.
Created At	addresses.created_at	string	The created at.
Updated At	addresses.updated_at	string	The last updated at.
Address	primary_address.address_1	string	The address.
Address Line 2	primary_address.address_2	string	The address line 2.
City	primary_address.city	string	The city.
State	primary_address.state	string	The state.
Zipcode	primary_address.zipcode	string	The zipcode.
Country	primary_address.country	string	The country.
Type	primary_address.type	string	The type.
Is Primary	primary_address.is_primary	integer	The is primary.
Created At	primary_address.created_at	string	When created at.
Updated At	primary_address.updated_at	string	When last updated at.
Recurring Contributions	stats.recurring_contributions	integer	The number of recurring contributions.
Total Contributions	stats.total_contributions	integer	The total number of contributions.
Tags	tags	array of string
Custom Fields	custom_fields	array of
Archived At	archived_at	string	When archived at.
Created At	created_at	string	The created at.
Updated At	updated_at	string	The last updated at.

Get a fund

Operation ID:

FundGetA

Retrieves a specific fund.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.

Returns

Name	Path	Type	Description
ID	id	string	The unique identifier.
Code	code	string	The code.
Name	name	string	The name.
Raised	raised	float	The amount raised.
Supporters	supporters	integer	The number of supporters.
Created At	created_at	string	The created at.
Updated At	updated_at	string	The last updated at.

Get a member

Operation ID:

MemberGetA

Retrieves a specific member.

Parameters

Name	Key	Required	Type	Description
Campaign ID	campaign_id	True	string	The campaign unique identifier.
Member ID	member_id	True	string	The member unique identifier.

Returns

Name	Path	Type	Description
ID	id	integer	The unique identifier.
First Name	first_name	string	The first name.
Last Name	last_name	string	The last name.
Email	email	string	The email address.
Phone	phone	string	The phone number.
Picture	picture	string	The picture.
Raised	raised	integer	The amount raised.
Goal	goal	integer	The goal.
Donors	donors	integer	The number of donors.
Items	items	integer	The number of items.
URL	url	string	The URL address.

Get a payout

Operation ID:

PayoutGetA

Retrieves a specific payout

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.

Returns

Name	Path	Type	Description
ID	id	string	The unique identifier.
Campaign ID	campaign_id	integer	The campaign unique identifier.
Method	method	string	The method.
Status	status	string	The status.
Amount	amount	integer	The amount.
Fee	fee	integer	The fee.
Tip	tip	integer	The tip.
Payout	payout	integer	The payout.
Currency	currency	string	The currency.
Address	address.address_1	string	The address.
Address Line 2	address.address_2	string	The address line 2.
City	address.city	string	The city.
State	address.state	string	The state.
Zipcode	address.zipcode	string	The zipcode.
Country	address.country	string	The country.
Memo	memo	string	The memo.
Completed At	completed_at	string	When completed at.
Created At	created_at	string	The created at.

Get a plan

Operation ID:

PlanGetA

Retrieves a specific plan.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.

Returns

Name	Path	Type	Description
ID	id	string	The unique identifier.
First Name	first_name	string	The first name.
Last Name	last_name	string	The last name.
Email	email	string	The email address.
Phone	phone	string	The phone number.
Frequency	frequency	string	The frequency.
Status	status	string	The status.
Method	method	string	The method.
Amount	amount	integer	The amount.
Fee Covered	fee_covered	float	The fee covered.
Created At	created_at	string	The created at.
Start At	start_at	string	When started at.
Next Bill Date	next_bill_date	string	The next bill date.

Get a team

Operation ID:

TeamGetA

Retrieves a specific team.

Parameters

Name	Key	Required	Type	Description
Campaign ID	campaign_id	True	string	The campaign unique identifier.
Team ID	team_id	True	string	The team unique identifier.

Returns

Name	Path	Type	Description
ID	id	integer	The unique identifier.
Name	name	string	The name.
Logo	logo	string	The logo.
Slug	slug	string	The slug.
URL	url	string	The URL address.
Raised	raised	integer	The amount raised.
Goal	goal	integer	The goal.
Supporters	supporters	integer	The number of supporters.
Members	members	integer	The number of members.

Get a ticket

Operation ID:

TicketGetA

Retrieves a specific ticket.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.

Returns

Name	Path	Type	Description
ID	id	string	The unique identifier.
ID Suffix	id_suffix	string	The ID suffix.
Name	name	string	The name.
First Name	first_name	string	The first name.
Last Name	last_name	string	The last name.
Email	email	string	The email address.
Phone	phone	string	The phone number.
Title	title	string	The title.
Description	description	string	The description.
Price	price	integer	The price.
PDF	pdf	string	The PDF.
Arrived At	arrived_at	string	When arrived at.
Created At	created_at	string	The created at.

Get a transaction

Operation ID:

TransactionGetA

Retrieves a specific transaction.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.

Returns

Name	Path	Type	Description
ID	id	string	The unique identifier.
Campaign ID	campaign_id	integer	The campaign unique identifier.
Team ID	team_id	string	The team unique identifier.
Member ID	member_id	string	The member unique identifier.
First Name	first_name	string	The first name.
Last Name	last_name	string	The last name.
Email	email	string	The email address.
Phone	phone	string	The phone number.
Address	address.address_1	string	The address.
Address Line 2	address.address_2	string	The address line 2.
City	address.city	string	The city.
State	address.state	string	The state.
Zipcode	address.zipcode	string	The zipcode.
Country	address.country	string	The country.
Status	status	string	The status.
Method	method	string	The method.
Amount	amount	integer	The amount.
Fee	fee	float	The fee.
Fee Covered	fee_covered	float	The fee covered.
Donated	donated	integer	The number donated.
Payout	payout	integer	The payout.
Currency	currency	string	The currency.
Created At	created_at	string	The created at.
ID	giving_space.id	integer	The unique identifier.
Name	giving_space.name	string	The name.
Amount	giving_space.amount	integer	The amount.
Message	giving_space.message	string	The message.
Transactions	transactions	array of object
ID	transactions.id	string	The unique identifier.
Plan ID	transactions.plan_id	string	The plan unique identifier.
Amount	transactions.amount	integer	The amount.
Fee	transactions.fee	float	The fee.
Fee Covered	transactions.fee_covered	float	The fee covered.
Donated	transactions.donated	integer	The number donated.
Payout	transactions.payout	integer	The payout.
Captured	transactions.captured	boolean	Whether captured.
Captured At	transactions.captured_at	string	When captured at.
Refunded	transactions.refunded	boolean	Whether refunded.
Line Items	transactions.line_items	array of object
Type	transactions.line_items.type	string	The type.
Subtype	transactions.line_items.subtype	string	The subtype.
Description	transactions.line_items.title	string	The description.
Quantity	transactions.line_items.quantity	integer	The quantity.
Price	transactions.line_items.price	float	The price.
Discount	transactions.line_items.discount	integer	The discount.
Total	transactions.line_items.total	float	The total.

Get campaigns

Operation ID:

CampaignGet

Retrieves a list of your campaigns.

Parameters

Name	Key	Required	Type	Description
Scope	scope		string	The scope.

Returns

Name	Path	Type	Description
Data	data	array of object
ID	data.id	integer	The unique identifier.
Account ID	data.account_id	string	The unique identifier of the account.
Type	data.type	string	The type.
Title	data.title	string	The title.
Subtitle	data.subtitle	string	The subtitle.
Description	data.description	string	The description.
Slug	data.slug	string	The slug.
URL	data.url	string	The URL address.
Goal	data.goal	integer	The goal.
Raised	data.raised	integer	The amount raised.
Donors	data.donors	integer	The number of donors.
Currency	data.currency	string	The currency.
Logo	data.logo	string	The logo.
Type	data.cover.type	string	The type.
URL	data.cover.url	string	The URL address.
Source	data.cover.source	string	The source.
End At	data.end_at	string	When the end is at.
Created At	data.created_at	string	The created at.
Updated At	data.updated_at	string	The last updated at.
Title	data.event.title	string	The title.
Type	data.event.type	string	The type.
Location Name	data.event.location_name	string	The location name.
Address Formatted	data.event.address_formatted	string	The formatted address.
Google Place ID	data.event.google_place_id	string	The Google Place unique identifier.
Start At	data.event.start_at	string	When the start is at.
End At	data.event.end_at	string	The end at.
Timezone	data.event.timezone	string	The timezone.
Details	data.event.details	string	The details.
Private	data.event.private	boolean	Whether private.
Tickets Required	data.event.tickets_required	boolean	Whether tickets are required.
URL	data.event.livestream.url	string	The URL address.
Type	data.event.livestream.type	string	The type.
Location	data.event.livestream.location	string	The location.
Platform	data.event.livestream.platform	string	The platform.
Embed URL	data.event.livestream.embed_url	string	The embed URL address.
Scheduled	data.event.livestream.scheduled	boolean	Whether scheduled.
Livestream Start At	data.event.livestream_start_at	string	When the livestream starts at.
Livestream End At	data.event.livestream_end_at	string	When the livestream ends at.
First	links.first	string	The first.
Last	links.last	string	The last.
Previous	links.prev	string	The previous.
Next	links.next	string	The next.
Current Page	meta.current_page	integer	The current page.
From	meta.from	integer	The number from.
Last Page	meta.last_page	integer	The last page number.
Links	meta.links	array of object
URL	meta.links.url	string	The URL address.
Label	meta.links.label	string	The label.
Active	meta.links.active	boolean	Whether active.
Path	meta.path	string	The path.
Per Page	meta.per_page	integer	The number per page.
To	meta.to	integer	The number to.
Total	meta.total	integer	The total number.
Unfiltered Total	meta.unfiltered_total	integer	The unfiltered total number.

Get contacts

Operation ID:

ContactGet

Retrieves a list of contacts.

Parameters

Name	Key	Required	Type	Description
Scope	scope		string	The scope.

Returns

Name	Path	Type	Description
Data	data	array of object
ID	data.id	integer	The unique identifier.
First Name	data.first_name	string	The first name.
Middle Name	data.middle_name	string	The middle name.
Last Name	data.last_name	string	The last name.
DOB	data.dob	string	The date of birth.
Company	data.company	string	The company.
Title	data.title	string	The title.
Twitter URL	data.twitter_url	string	The Twitter URL address.
LinkedIn URL	data.linkedin_url	string	The LinkedIn URL address.
Facebook URL	data.facebook_url	string	The Facebook URL address.
Emails	data.emails	array of object
Type	data.emails.type	string	The type.
Value	data.emails.value	string	The value.
Phones	data.phones	array of object
Type	data.phones.type	string	The type.
Value	data.phones.value	string	The value.
Primary Email	data.primary_email	string	The primary email address.
Primary Phone	data.primary_phone	string	The primary phone number.
Note	data.note	string	The note.
Addresses	data.addresses	array of object
Address	data.addresses.address_1	string	The address.
Address Line 2	data.addresses.address_2	string	The address line 2.
City	data.addresses.city	string	The city.
State	data.addresses.state	string	The state.
Zipcode	data.addresses.zipcode	string	The zipcode.
Country	data.addresses.country	string	The country.
Type	data.addresses.type	string	The type.
Is Primary	data.addresses.is_primary	integer	The is primary.
Created At	data.addresses.created_at	string	When created at.
Updated At	data.addresses.updated_at	string	When last updated at.
Address	data.primary_address.address_1	string	The address.
Address Line 2	data.primary_address.address_2	string	The address line 2.
City	data.primary_address.city	string	The city.
State	data.primary_address.state	string	The state.
Zipcode	data.primary_address.zipcode	string	The zipcode.
Country	data.primary_address.country	string	The country.
Type	data.primary_address.type	string	The type.
Is Primary	data.primary_address.is_primary	integer	The is primary.
Created At	data.primary_address.created_at	string	When created at.
Updated At	data.primary_address.updated_at	string	When updated at.
Recurring Contributions	data.stats.recurring_contributions	integer	The number of recurring contributions.
Total Contributions	data.stats.total_contributions	integer	The total number of contributions.
Tags	data.tags	array of string	The tags.
Custom Fields	data.custom_fields	array of	The custom fields.
Archived At	data.archived_at	string	When archived at.
Created At	data.created_at	string	The created at.
Updated At	data.updated_at	string	The last updated at.
First	links.first	string	The first.
Last	links.last	string	The last.
Previous	links.prev	string	The previous.
Next	links.next	string	The next.
Current Page	meta.current_page	integer	The current page.
From	meta.from	integer	The number from.
Last Page	meta.last_page	integer	The last page number.
Links	meta.links	array of object
URL	meta.links.url	string	The URL address.
Label	meta.links.label	string	The label.
Active	meta.links.active	boolean	Whether active.
Path	meta.path	string	The path.
Per Page	meta.per_page	integer	The number per page.
To	meta.to	integer	The number to.
Total	meta.total	integer	The total number.

Get funds

Operation ID:

FundGet

Retrieves a list of funds.

Returns

Name	Path	Type	Description
Data	data	array of object
ID	data.id	string	The unique identifier.
Code	data.code	string	The code.
Name	data.name	string	The name.
Raised	data.raised	float	The amount raised.
Supporters	data.supporters	integer	The number of supporters.
Created At	data.created_at	string	The created at.
Updated At	data.updated_at	string	The last updated at.
First	links.first	string	The first.
Last	links.last	string	The last.
Previous	links.prev	string	The previous.
Next	links.next	string	The next.
Current Page	meta.current_page	integer	The current page.
From	meta.from	integer	The number from.
Last Page	meta.last_page	integer	The last page number.
Links	meta.links	array of object
URL	meta.links.url	string	The URL address.
Label	meta.links.label	string	The label.
Active	meta.links.active	boolean	Whether active.
Path	meta.path	string	The path.
Per Page	meta.per_page	integer	The number per page.
To	meta.to	integer	The number to.
Total	meta.total	integer	The total number.

Get members

Operation ID:

MemberGet

Retrieves a list of the members of a specific campaign.

Parameters

Name	Key	Required	Type	Description
Campaign ID	campaign_id	True	string	The campaign unique identifier.

Returns

Name	Path	Type	Description
Data	data	array of object
ID	data.id	integer	The unique identifier.
First Name	data.first_name	string	The first name.
Last Name	data.last_name	string	The last name.
Email	data.email	string	The email address.
Phone	data.phone	string	The phone number.
Picture	data.picture	string	The picture.
Raised	data.raised	integer	The amount raised.
Goal	data.goal	integer	The goal.
Donors	data.donors	integer	The number of donors.
Items	data.items	integer	The number of items.
URL	data.url	string	The URL address.
First	links.first	string	The first.
Last	links.last	string	The last.
Previous	links.prev	string	The previous.
Next	links.next	string	The next.
Current Page	meta.current_page	integer	The current page.
From	meta.from	integer	The number from.
Last Page	meta.last_page	integer	The last page number.
Links	meta.links	array of object
URL	meta.links.url	string	The URL address.
Label	meta.links.label	string	The label.
Active	meta.links.active	boolean	Whether active.
Path	meta.path	string	The path.
Per Page	meta.per_page	integer	The number per page.
To	meta.to	integer	The number to.
Total	meta.total	integer	The total number.

Get payouts

Operation ID:

PayoutGet

Retrieves a list of payouts

Returns

Name	Path	Type	Description
Data	data	array of object
ID	data.id	string	The unique identifier.
Campaign ID	data.campaign_id	integer	The campaign unique identifier.
Method	data.method	string	The method.
Status	data.status	string	The status.
Amount	data.amount	integer	The amount.
Fee	data.fee	integer	The fee.
Tip	data.tip	integer	The tip.
Payout	data.payout	integer	The payout.
Currency	data.currency	string	The currency.
Address	data.address.address_1	string	The address.
Address Line 2	data.address.address_2	string	The address line 2.
City	data.address.city	string	The city.
State	data.address.state	string	The state.
Zipcode	data.address.zipcode	string	The zipcode.
Country	data.address.country	string	The country.
Memo	data.memo	string	The memo.
Completed At	data.completed_at	string	When completed at.
Created At	data.created_at	string	The created at.
First	links.first	string	The first.
Last	links.last	string	The last.
Previous	links.prev	string	The previous.
Next	links.next	string	The next.
Current Page	meta.current_page	integer	The current page.
From	meta.from	integer	The number from.
Last Page	meta.last_page	integer	The last page number.
Links	meta.links	array of object
URL	meta.links.url	string	The URL address.
Label	meta.links.label	string	The label.
Active	meta.links.active	boolean	Whether active.
Path	meta.path	string	The path.
Per Page	meta.per_page	integer	The number per page.
To	meta.to	integer	The number to.
Total	meta.total	integer	The total number.

Get plans

Operation ID:

PlanGet

Retrieves a list of plans

Returns

Name	Path	Type	Description
Data	data	array of object
ID	data.id	string	The unique identifier.
First Name	data.first_name	string	The first name.
Last Name	data.last_name	string	The last name.
Email	data.email	string	The email address.
Phone	data.phone	string	The phone number.
Frequency	data.frequency	string	The frequency.
Status	data.status	string	The status.
Method	data.method	string	The method.
Amount	data.amount	integer	The amount.
Fee Covered	data.fee_covered	float	The fee covered.
Created At	data.created_at	string	The created at.
Start At	data.start_at	string	When started at.
Next Bill Date	data.next_bill_date	string	The next bill date.
First	links.first	string	The first.
Last	links.last	string	The last.
Previous	links.prev	string	The previous.
Next	links.next	string	The next.
Current Page	meta.current_page	integer	The current page.
From	meta.from	integer	The number from.
Last Page	meta.last_page	integer	The last page number.
Links	meta.links	array of object
URL	meta.links.url	string	The URL address.
Label	meta.links.label	string	The label.
Active	meta.links.active	boolean	Whether active.
Path	meta.path	string	The path.
Per Page	meta.per_page	integer	The number per page.
To	meta.to	integer	The number to.
Total	meta.total	integer	The total number.

Get teams

Operation ID:

TeamGet

Retrieves a list of the teams under a specific campaign.

Parameters

Name	Key	Required	Type	Description
Campaign ID	campaign_id	True	string	The campaign unique identifier.

Returns

Name	Path	Type	Description
Data	data	array of object
ID	data.id	integer	The unique identifier.
Name	data.name	string	The name.
Logo	data.logo	string	The logo.
Slug	data.slug	string	The slug.
URL	data.url	string	The URL address.
Raised	data.raised	integer	The amount raised.
Goal	data.goal	integer	The goal.
Supporters	data.supporters	integer	The number of supporters.
Members	data.members	integer	The members.
First	links.first	string	The first.
Last	links.last	string	The last.
Previous	links.prev	string	The previous.
Next	links.next	string	The next.
Current Page	meta.current_page	integer	The current page.
From	meta.from	integer	The number from.
Last Page	meta.last_page	integer	The last page number.
Links	meta.links	array of object
URL	meta.links.url	string	The URL address.
Label	meta.links.label	string	The label.
Active	meta.links.active	boolean	Whether active.
Path	meta.path	string	The path.
Per Page	meta.per_page	integer	The number per page.
To	meta.to	integer	The number to.
Total	meta.total	integer	The total number.

Get tickets

Operation ID:

TicketGet

Retrieve a list of your tickets.

Returns

Name	Path	Type	Description
Data	data	array of object
ID	data.id	string	The unique identifier.
ID Suffix	data.id_suffix	string	The ID suffix.
Name	data.name	string	The name.
First Name	data.first_name	string	The first name.
Last Name	data.last_name	string	The last name.
Email	data.email	string	The email address.
Phone	data.phone	string	The phone number.
Title	data.title	string	The title.
Description	data.description	string	The description.
Price	data.price	integer	The price.
PDF	data.pdf	string	The PDF.
Arrived At	data.arrived_at	string	When arrived at.
Created At	data.created_at	string	The created at.
First	links.first	string	The first.
Last	links.last	string	The last.
Previous	links.prev	string	The previous.
Next	links.next	string	The next.
Current Page	meta.current_page	integer	The current page.
From	meta.from	integer	The number from.
Last Page	meta.last_page	integer	The last page number.
Links	meta.links	array of object
URL	meta.links.url	string	The URL address.
Label	meta.links.label	string	The label.
Active	meta.links.active	boolean	Whether active.
Path	meta.path	string	The path.
Per Page	meta.per_page	integer	The number per page.
To	meta.to	integer	The number to.
Total	meta.total	integer	The total number.

Get transactions

Operation ID:

TransactionGet

Retrieves a list of transactions

Returns

Name	Path	Type	Description
Data	data	array of object
ID	data.id	string	The unique identifier.
Campaign ID	data.campaign_id	integer	The campaign unique identifier.
Team ID	data.team_id	string	The team unique identifier.
Member ID	data.member_id	string	The member unique identifier.
First Name	data.first_name	string	The first name.
Last Name	data.last_name	string	The last name.
Email	data.email	string	The email address.
Phone	data.phone	string	The phone number.
Address	data.address.address_1	string	The address.
Address Line 2	data.address.address_2	string	The address line 2.
City	data.address.city	string	The city.
State	data.address.state	string	The state.
Zipcode	data.address.zipcode	string	The zipcode.
Country	data.address.country	string	The country.
Status	data.status	string	The status.
Method	data.method	string	The method.
Amount	data.amount	integer	The amount.
Fee	data.fee	float	The fee.
Fee Covered	data.fee_covered	float	The fee covered.
Donated	data.donated	integer	The number donated.
Payout	data.payout	integer	The payout.
Currency	data.currency	string	The currency.
Created At	data.created_at	string	The created at.
ID	data.giving_space.id	integer	The unique identifier.
Name	data.giving_space.name	string	The name.
Amount	data.giving_space.amount	integer	The amount.
Message	data.giving_space.message	string	The message.
Transactions	data.transactions	array of object
ID	data.transactions.id	string	The unique identifier.
Plan ID	data.transactions.plan_id	string	The plan unique identifier.
Amount	data.transactions.amount	integer	The amount.
Fee	data.transactions.fee	float	The fee.
Fee Covered	data.transactions.fee_covered	float	The fee covered.
Donated	data.transactions.donated	integer	The number donated.
Payout	data.transactions.payout	integer	The payout.
Captured	data.transactions.captured	boolean	Whether captured.
Captured At	data.transactions.captured_at	string	The captured at.
Refunded	data.transactions.refunded	boolean	Whether refunded.
Line Items	data.transactions.line_items	array of object
Type	data.transactions.line_items.type	string	The type.
Subtype	data.transactions.line_items.subtype	string	The subtype.
Description	data.transactions.line_items.description	string	The description.
Quantity	data.transactions.line_items.quantity	integer	The quantity.
Price	data.transactions.line_items.price	float	The price.
Discount	data.transactions.line_items.discount	integer	The discount.
Total	data.transactions.line_items.total	float	The total.
First	links.first	string	The first.
Last	links.last	string	The last.
Previous	links.prev	string	The previous.
Next	links.next	string	The next.
Current Page	meta.current_page	integer	The current page.
From	meta.from	integer	The number from.
Last Page	meta.last_page	integer	The last page number.
Links	meta.links	array of object
URL	meta.links.url	string	The URL address.
Label	meta.links.label	string	The label.
Active	meta.links.active	boolean	Whether active.
Path	meta.path	string	The path.
Per Page	meta.per_page	integer	The number per page.
To	meta.to	integer	The number to.
Total	meta.total	integer	The total number.

Restore a contact

Operation ID:

ContactRestore

Restores a deleted contact

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.

Returns

Name	Path	Type	Description
ID	id	integer	The unique identifier.
First Name	first_name	string	The first name.
Middle Name	middle_name	string	The middle name.
Last Name	last_name	string	The last name.
DOB	dob	string	The date of birth.
Company	company	string	The company.
Title	title	string	The title.
Twitter URL	twitter_url	string	The Twitter URL address.
LinkedIn URL	linkedin_url	string	The LinkedIn URL address.
Facebook URL	facebook_url	string	The Facebook URL address.
Emails	emails	array of object
Type	emails.type	string	The type.
Value	emails.value	string	The value.
Phones	phones	array of object
Type	phones.type	string	The type.
Value	phones.value	string	The value.
Primary Email	primary_email	string	The primary email address.
Primary Phone	primary_phone	string	The primary phone number.
Note	note	string	The note.
Addresses	addresses	array of object
Address	addresses.address_1	string	The address.
Address Line 2	addresses.address_2	string	The address line 2.
City	addresses.city	string	The city.
State	addresses.state	string	The state.
Zipcode	addresses.zipcode	string	The zipcode.
Country	addresses.country	string	The country.
Type	addresses.type	string	The type.
Is Primary	addresses.is_primary	integer	The is primary.
Created At	addresses.created_at	string	The created at.
Updated At	addresses.updated_at	string	The last updated at.
Address	primary_address.address_1	string	The address.
Address Line 2	primary_address.address_2	string	The address line 2.
City	primary_address.city	string	The city.
State	primary_address.state	string	The state.
Zipcode	primary_address.zipcode	string	The zipcode.
Country	primary_address.country	string	The country.
Type	primary_address.type	string	The type.
Is Primary	primary_address.is_primary	integer	The is primary.
Created At	primary_address.created_at	string	When created at.
Updated At	primary_address.updated_at	string	When last updated at.
Recurring Contributions	stats.recurring_contributions	integer	The number of recurring contributions.
Total Contributions	stats.total_contributions	integer	The total number of contributions.
Tags	tags	array of string
Custom Fields	custom_fields	array of
Archived At	archived_at	string	When archived at.
Created At	created_at	string	The created at.
Updated At	updated_at	string	The last updated at.

Update a campaign

Operation ID:

CampaignPatch

Updates an existing campaign.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.
Description	description		string	The description.
End At	end_at		string	When the end is at.
Goal	goal		string	The goal.
Subtitle	subtitle		string	The subtitle.
Slug	slug		string	The slug.
Title	title		string	The title.
Type	type		string	The type.

Returns

Name	Path	Type	Description
ID	id	integer	The unique identifier.
Account ID	account_id	string	The account unique identifier.
Type	type	string	The type.
Title	title	string	The title.
Subtitle	subtitle	string	The subtitle.
Description	description	string	The description.
Slug	slug	string	The slug.
URL	url	string	The URL address.
Goal	goal	integer	The goal.
Raised	raised	integer	The amount raised.
Donors	donors	integer	The number of donors.
Currency	currency	string	The currency.
Logo	logo	string	The logo.
Type	cover.type	string	The type.
URL	cover.url	string	The URL address.
Source	cover.source	string	The source.
End At	end_at	string	When the end is at.
Created At	created_at	string	The created at.
Updated At	updated_at	string	The last updated at.

Update a contact

Operation ID:

ContactPatch

Updates a specific contact.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.
First Name	first_name		string	The first name.
Middle Name	middle_name		string	The middle name.
Last Name	last_name		string	The last name.
DOB	dob		string	The date of birth.
Company	company		string	The company.
Title	title		string	The title.
Twitter URL	twitter_url		string	The Twitter URL address.
LinkedIn URL	linkedin_url		string	The LinkedIn URL address.
Facebook URL	facebook_url		string	The Facebook URL address.

Returns

Name	Path	Type	Description
ID	id	integer	The unique identifier.
First Name	first_name	string	The first name.
Middle Name	middle_name	string	The middle name.
Last Name	last_name	string	The last name.
DOB	dob	string	The date of birth.
Company	company	string	The company.
Title	title	string	The title.
Twitter URL	twitter_url	string	The Twitter URL address.
LinkedIn URL	linkedin_url	string	The LinkedIn URL address.
Facebook URL	facebook_url	string	The Facebook URL address.
Emails	emails	array of object
Type	emails.type	string	The type.
Value	emails.value	string	The value.
Phones	phones	array of object
Type	phones.type	string	The type.
Value	phones.value	string	The value.
Primary Email	primary_email	string	The primary email address.
Primary Phone	primary_phone	string	The primary phone number.
Note	note	string	The note.
Addresses	addresses	array of object
Address	addresses.address_1	string	The address.
Address Line 2	addresses.address_2	string	The address line 2.
City	addresses.city	string	The city.
State	addresses.state	string	The state.
Zipcode	addresses.zipcode	string	The zipcode.
Country	addresses.country	string	The country.
Type	addresses.type	string	The type.
Is Primary	addresses.is_primary	integer	The is primary.
Created At	addresses.created_at	string	The created at.
Updated At	addresses.updated_at	string	The last updated at.
Address	primary_address.address_1	string	The address.
Address Line 2	primary_address.address_2	string	The address line 2.
City	primary_address.city	string	The city.
State	primary_address.state	string	The state.
Zipcode	primary_address.zipcode	string	The zipcode.
Country	primary_address.country	string	The country.
Type	primary_address.type	string	The type.
Is Primary	primary_address.is_primary	integer	The is primary.
Created At	primary_address.created_at	string	When created at.
Updated At	primary_address.updated_at	string	When last updated at.
Recurring Contributions	stats.recurring_contributions	integer	The number of recurring contributions.
Total Contributions	stats.total_contributions	integer	The total number of contributions.
Tags	tags	array of string
Custom Fields	custom_fields	array of
Archived At	archived_at	string	When archived at.
Created At	created_at	string	The created at.
Updated At	updated_at	string	The last updated at.

Update a fund

Operation ID:

FundPatch

Updates a specific fund.

Parameters

Name	Key	Required	Type	Description
ID	id	True	string	The unique identifier.
Name	name		string	The name.
Code	code		string	The code.

Returns

Name	Path	Type	Description
ID	id	string	The unique identifier.
Code	code	string	The code.
Name	name	string	The name.
Raised	raised	integer	The amount raised.
Supporters	supporters	integer	The number of supporters.
Created At	created_at	string	The created at.
Updated At	updated_at	string	The last updated at.

Definitions

string

This is the basic data type 'string'.