GlobalGiving Project (Independent Publisher) (Preview)

Reference

GlobalGiving connects nonprofits, donors, and companies in nearly every country in the world. We help fellow nonprofits access the funding, tools, training, and support they need to serve their communities.

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://www.globalgiving.org/
Privacy policy	https://www.globalgiving.org/aboutus/privacy/
Categories	Lifestyle and Entertainment

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	securestring	Please enter your API Key.	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Get access token	Access tokens are similar to session tokens and allow entering of credentials once per session. Once authenticated, a user is provided with an access token that is submitted with every secure request (those containing '/secure/' in the URL path, e.g. submitting a donation) instead of always submitting a username and password. Access tokens are short-lived and can expire so users need to re-GET a token at the start of each session or if their current access token expires. Note that access token timeouts are individually set for each API user as a database configuration and by default are set to 10 hours.
Get all organizations	This action retrieves information for all available organizations. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next organization id to include in the query string to retrieve the next set of results.
Get all project information for a set of project IDs	This action retrieves information for projects filtered by a list of comma separated project ids. The result set is limited to a maximum of 10 results for a request.
Get all project summary information for set of project IDs	This action retrieves a subset of the full project information for projects filtered by a list of comma separated project ids. The result set is limited to a maximum of 10 results for a request.
Get all projects	This action retrieves information for all projects. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.
Get all projects for a campaign	This action retrieves information for all projects in specific Campaign. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.
Get all projects for a campaign summary	This action retrieves a subset of the full project information for all projects in a specific campaign. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.
Get all projects for a country or region	This action retrieves information for all projects in a specific country or region. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.
Get all projects for a country or region summary	This action retrieves a subset of the full project information for all projects in a specific country or region. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.
Get all projects for a theme	This action retrieves information for all projects in a specific theme. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.
Get all projects for a theme summary	This action retrieves a subset of the full project information for all projects in a specific theme. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.
Get all projects for an organization	This action retrieves the full project information for all projects belonging to a specific organization. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.
Get all projects for an organization summary	This action retrieves the full project information for all projects belonging to a specific organization. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.
Get all projects IDs	This action retrieves all the available project IDs.
Get all projects summary	This action retrieves a subset of the full project information, for all projects. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.
Get featured projects	This action retrieves information for featured projects. The result set will always return 10 results. The featured projects are rotated hourly based on GlobalGiving ranking, and a "randomization" algorithm.
Get featured projects summary	This action retrieves summary information for featured projects. The result set will always return 10 results. The featured projects are rotated hourly based on GlobalGiving ranking, and a "randomization" algorithm.
Get gift card designs	When sending out email gift cards a gift card design must be specified. This action retrieves all the available GlobalGiving gift card designs to select from.
Get gift certificate details	This action allows a user to query the validity and details of a gift certificate.
Get GlobalGiving themes	This action retrieves all GlobalGiving themes.
Get image gallery	This action retrieves any extra images for a specific project. When requesting full information, the indicates the number of images available. If this number is greater than zero you can access the extra images using This action.
Get max third party ID	This action retrieves the max (greatest alphabetically) third party transaction id associated with this API key. This is a secure request therefore, an access token (authentication) is required.
Get organization	This action retrieves information for a specific organization.
Get outstanding invoices	This action retrieves all outstanding invoices not yet reconciled. This is a secure request therefore, an access token (authentication) is required.
Get region project counts	This action retrieves all regions and countries with their associated project counts.
Get region project counts for a specific region	This action retrieves project counts for a specific region.
Get regions	This action retrieves all regions.
Get specific project	This action displays information for a specific project.
Get specific project summary	This action displays a subset of the full project information for a specific project.
Get themes with project IDs	This action retrieves all GlobalGiving themes with their associated project IDs.
Order a gift certificate	This action allows a user to submit an order for a gift certificate without submitting payment details. This allows GlobalGiving the ability to immediately generate gift certificates with the understanding that reconciliation of the order will take place at a later date.
Search projects	This action allows searching for projects using keywords.
Send a gift card	This action allows a user to send a gift card.
Submit a donation	This action allows a user to submit a donation request.

Get access token

Operation ID:: AccessTokenGet

Access tokens are similar to session tokens and allow entering of credentials once per session. Once authenticated, a user is provided with an access token that is submitted with every secure request (those containing '/secure/' in the URL path, e.g. submitting a donation) instead of always submitting a username and password. Access tokens are short-lived and can expire so users need to re-GET a token at the start of each session or if their current access token expires. Note that access token timeouts are individually set for each API user as a database configuration and by default are set to 10 hours.

Parameters

Name	Key	Type	Description
Email	email	string	The account email address.
Password	password	string	The account password.
API Key	api_key	string	The account API key.

Returns

Name	Path	Type	Description
Access Token	auth_response.access_token	string	The access token.

Get all organizations

Operation ID:: OrganizationGetAll

This action retrieves information for all available organizations. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next organization id to include in the query string to retrieve the next set of results.

Parameters

Name	Key	Required	Type	Description
Next Project ID	nextProjectId		string	The unique identifier of the next project.

Returns

Name	Path	Type	Description
Has Next	organizations.hasNext	boolean	Whether there is a next page.
Next Org ID	organizations.nextOrgId	integer	The unique identifier of the next organization.
organization	organizations.organization	array of

Get all project information for a set of project IDs

Operation ID:: ProjectInformationGet

This action retrieves information for projects filtered by a list of comma separated project ids. The result set is limited to a maximum of 10 results for a request.

Parameters

Name	Key	Required	Type	Description
Project IDs	projectIds		string	The project unique identifiers.

Returns

Name	Path	Type	Description
Has Next	projects.hasNext	boolean	Whether there is a next page.
Next Project ID	projects.nextProjectId	integer	The identifier of the next project.
Project	projects.project	array of object
Active	projects.project.active	boolean	Whether the project is active.
Country	projects.project.countries.country	array of object
ISO3166 Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Country	projects.project.country	array of string	The country(ies).
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.description	string	The description.
ID	projects.project.id	integer	The unique identifier.
Image Link	projects.project.imageLink	string	The link to the image.
ISO3166 Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	array of string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The ISO3166 country code.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
State	projects.project.organization.state	string	The state.
Postal	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	integer	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The ISO3166 country code.
Name	projects.project.organization.countries.country.name	string	The name.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme Name	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifier.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
Number Found	projects._numberFound	integer	The number of results found.

Get all project summary information for set of project IDs

Operation ID:: ProjectInformationSetIDs

This action retrieves a subset of the full project information for projects filtered by a list of comma separated project ids. The result set is limited to a maximum of 10 results for a request.

Parameters

Name	Key	Required	Type	Description
Project IDs	projectIds		string	The project unique identifiers.

Returns

Name	Path	Type	Description
Has Next	projects.hasNext	boolean	Whether there is a next page.
Next Project ID	projects.nextProjectId	integer	The identifier of the next project.
Active	projects.project.active	boolean	Whether it is active.
Activities	projects.project.activities	string	The activities.
Additional Documentation	projects.project.additionalDocumentation	string	Any additional documentation.
Approved Date	projects.project.approvedDate	string	The approved date.
Contact Address	projects.project.contactAddress	string	The contact's address.
Contact Address 2	projects.project.contactAddress2	string	The contact's address line 2.
Contact City	projects.project.contactCity	string	The contact's city.
Contact Country	projects.project.contactCountry	string	The contact's country.
Contact Name	projects.project.contactName	string	The contact's name.
Contact Postal	projects.project.contactPostal	string	The contact's postal.
Contact State	projects.project.contactState	string	The contact's state.
Contact Title	projects.project.contactTitle	string	The contact's title.
Contact URL	projects.project.contactUrl	string	The contact's URL.
Country	projects.project.country	string	The country.
Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Report Date	projects.project.dateOfMostRecentReport	string	The date of most recent report.
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.title	string	The description.
Funding	projects.project.funding	number	The funding.
Goal	projects.project.goal	integer	The goal.
ID	projects.project.id	integer	The unique identifier.
Gallery Size	projects.project.imageGallerySize	string	The image gallery size.
Image Link	projects.project.imageLink	string	The image link.
Image Link	projects.project.image.imagelink	array of object
URL	projects.project.image.imagelink.url	string	The URL address.
Size	projects.project.image.imagelink._size	string	The size
Title	projects.project.image.title	string	The title.
ID	projects.project.image._id	integer	The unique identifier.
Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Long Term Impact	projects.project.longTermImpact	string	The long term impact.
Modified Date	projects.project.modifiedDate	string	The modified date.
Need	projects.project.need	string	The need.
Notice	projects.project.notice	string	The notice.
Number of Donations	projects.project.numberOfDonations	integer	The number of donations.
Number of Reports	projects.project.numberOfReports	string	The number of reports.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
Postal Code	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	integer	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.organization.countries.country.name	string	The name.
Progress Report URL	projects.project.progressReportLink	string	The progress report link.
Project URL	projects.project.projectLink	string	The project link.
Region	projects.project.region	string	The region.
Remaining	projects.project.remaining	string	The remaining.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifer.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
URL	projects.project.videos.video.url	string	The URL address.

Get all projects

Operation ID:: ProjectGet

This action retrieves information for all projects. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.

Parameters

Name	Key	Required	Type	Description
Next Project ID	nextProjectId		integer	The unique identifier of the next project.

Returns

Name	Path	Type	Description
Has Next	projects.hasNext	boolean	Whether there is a next page.
Next Project ID	projects.nextProjectId	integer	The identifier of the next project.
Active	projects.project.active	boolean	Whether it is active.
Activities	projects.project.activities	string	The activities.
Additional Documentation	projects.project.additionalDocumentation	string	Any additional documentation.
Approved Date	projects.project.approvedDate	string	The approved date.
Contact Address	projects.project.contactAddress	string	The contact's address.
Contact Address 2	projects.project.contactAddress2	string	The contact's address line 2.
Contact City	projects.project.contactCity	string	The contact's city.
Contact Country	projects.project.contactCountry	string	The contact's country.
Contact Name	projects.project.contactName	string	The contact's name.
Contact Postal	projects.project.contactPostal	string	The contact's postal.
Contact State	projects.project.contactState	string	The contact's state.
Contact Title	projects.project.contactTitle	string	The contact's title.
Contact URL	projects.project.contactUrl	string	The contact's URL.
Country	projects.project.country	string	The country.
Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Report Date	projects.project.dateOfMostRecentReport	string	The date of most recent report.
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.title	string	The description.
Funding	projects.project.funding	number	The funding.
Goal	projects.project.goal	integer	The goal.
ID	projects.project.id	integer	The unique identifier.
Gallery Size	projects.project.imageGallerySize	string	The image gallery size.
Image Link	projects.project.imageLink	string	The image link.
Image Link	projects.project.image.imagelink	array of object
URL	projects.project.image.imagelink.url	string	The URL address.
Size	projects.project.image.imagelink._size	string	The size
Title	projects.project.image.title	string	The title.
ID	projects.project.image._id	integer	The unique identifier.
Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Long Term Impact	projects.project.longTermImpact	string	The long term impact.
Modified Date	projects.project.modifiedDate	string	The modified date.
Need	projects.project.need	string	The need.
Notice	projects.project.notice	string	The notice.
Number of Donations	projects.project.numberOfDonations	integer	The number of donations.
Number of Reports	projects.project.numberOfReports	string	The number of reports.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
Postal Code	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	integer	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.organization.countries.country.name	string	The name.
Progress Report URL	projects.project.progressReportLink	string	The progress report link.
Project URL	projects.project.projectLink	string	The project link.
Region	projects.project.region	string	The region.
Remaining	projects.project.remaining	string	The remaining.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifer.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
URL	projects.project.videos.video.url	string	The URL address.
Number Found	projects._numberFound	integer	The number of results found.

Get all projects for a campaign

Operation ID:: CampaignProjectGet

This action retrieves information for all projects in specific Campaign. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.

Parameters

Name	Key	Required	Type	Description
Campaign ID	campaignId	True	string	The unique identifier of the campaign.
Next Project ID	nextProjectId		integer	The unique identifier of the next project.

Returns

Name	Path	Type	Description
Has Next	projects.hasNext	boolean	Whether there is a next page.
Next Project ID	projects.nextProjectId	integer	The identifier of the next project.
Active	projects.project.active	boolean	Whether it is active.
Activities	projects.project.activities	string	The activities.
Additional Documentation	projects.project.additionalDocumentation	string	Any additional documentation.
Approved Date	projects.project.approvedDate	string	The approved date.
Contact Address	projects.project.contactAddress	string	The contact's address.
Contact Address 2	projects.project.contactAddress2	string	The contact's address line 2.
Contact City	projects.project.contactCity	string	The contact's city.
Contact Country	projects.project.contactCountry	string	The contact's country.
Contact Name	projects.project.contactName	string	The contact's name.
Contact Postal	projects.project.contactPostal	string	The contact's postal.
Contact State	projects.project.contactState	string	The contact's state.
Contact Title	projects.project.contactTitle	string	The contact's title.
Contact URL	projects.project.contactUrl	string	The contact's URL.
Country	projects.project.country	string	The country.
Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Report Date	projects.project.dateOfMostRecentReport	string	The date of most recent report.
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.title	string	The description.
Funding	projects.project.funding	number	The funding.
Goal	projects.project.goal	integer	The goal.
ID	projects.project.id	integer	The unique identifier.
Gallery Size	projects.project.imageGallerySize	string	The image gallery size.
Image Link	projects.project.imageLink	string	The image link.
Image Link	projects.project.image.imagelink	array of object
URL	projects.project.image.imagelink.url	string	The URL address.
Size	projects.project.image.imagelink._size	string	The size
Title	projects.project.image.title	string	The title.
ID	projects.project.image._id	integer	The unique identifier.
Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Long Term Impact	projects.project.longTermImpact	string	The long term impact.
Modified Date	projects.project.modifiedDate	string	The modified date.
Need	projects.project.need	string	The need.
Notice	projects.project.notice	string	The notice.
Number of Donations	projects.project.numberOfDonations	integer	The number of donations.
Number of Reports	projects.project.numberOfReports	string	The number of reports.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
Postal Code	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	string	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.organization.countries.country.name	string	The name.
Progress Report URL	projects.project.progressReportLink	string	The progress report link.
Project URL	projects.project.projectLink	string	The project link.
Region	projects.project.region	string	The region.
Remaining	projects.project.remaining	string	The remaining.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifer.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
URL	projects.project.videos.video.url	string	The URL address.
Number Found	projects._numberFound	integer	The number of results found.

Get all projects for a campaign summary

Operation ID:: CampaignSummaryProject

This action retrieves a subset of the full project information for all projects in a specific campaign. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.

Parameters

Name	Key	Required	Type	Description
Campaign ID	campaignId	True	string	The unique identifier of the campaign.
Next Project ID	nextProjectId		integer	The unique identifier of the next project.

Returns

Name	Path	Type	Description
Has Next	projects.hasNext	boolean	Whether there is a next page.
Next Project ID	projects.nextProjectId	integer	The identifier of the next project.
Active	projects.project.active	boolean	Whether it is active.
Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Country	projects.project.country	string	The country.
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.title	string	The description.
ID	projects.project.id	integer	The unique identifier.
Image Link	projects.project.imageLink	string	The image link.
Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
State	projects.project.organization.state	string	The state.
Postal Code	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	integer	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.organization.countries.country.name	string	The name.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifer.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
Number Found	projects._numberFound	integer	The number of results found.

Get all projects for a country or region

Operation ID:: ProjectCountryGet

This action retrieves information for all projects in a specific country or region. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.

Parameters

Name	Key	Required	Type	Description
Campaign ID	iso3166CountryCode	True	string	The unique identifier of the campaign.
Next Project ID	nextProjectId		integer	The unique identifier of the next project.

Returns

Name	Path	Type	Description
Has Next	projects.hasNext	boolean	Whether there is a next page.
Next Project ID	projects.nextProjectId	integer	The identifier of the next project.
Active	projects.project.active	boolean	Whether it is active.
Activities	projects.project.activities	string	The activities.
Additional Documentation	projects.project.additionalDocumentation	string	Any additional documentation.
Approved Date	projects.project.approvedDate	string	The approved date.
Contact Address	projects.project.contactAddress	string	The contact's address.
Contact Address 2	projects.project.contactAddress2	string	The contact's address line 2.
Contact City	projects.project.contactCity	string	The contact's city.
Contact Country	projects.project.contactCountry	string	The contact's country.
Contact Name	projects.project.contactName	string	The contact's name.
Contact Postal	projects.project.contactPostal	string	The contact's postal.
Contact State	projects.project.contactState	string	The contact's state.
Contact Title	projects.project.contactTitle	string	The contact's title.
Contact URL	projects.project.contactUrl	string	The contact's URL.
Country	projects.project.country	string	The country.
Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Report Date	projects.project.dateOfMostRecentReport	string	The date of most recent report.
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.title	string	The description.
Funding	projects.project.funding	number	The funding.
Goal	projects.project.goal	integer	The goal.
ID	projects.project.id	integer	The unique identifier.
Gallery Size	projects.project.imageGallerySize	string	The image gallery size.
Image Link	projects.project.imageLink	string	The image link.
Image Link	projects.project.image.imagelink	array of object
URL	projects.project.image.imagelink.url	string	The URL address.
Size	projects.project.image.imagelink._size	string	The size
Title	projects.project.image.title	string	The title.
ID	projects.project.image._id	integer	The unique identifier.
Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Long Term Impact	projects.project.longTermImpact	string	The long term impact.
Modified Date	projects.project.modifiedDate	string	The modified date.
Need	projects.project.need	string	The need.
Notice	projects.project.notice	string	The notice.
Number of Donations	projects.project.numberOfDonations	integer	The number of donations.
Number of Reports	projects.project.numberOfReports	string	The number of reports.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
Postal Code	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	integer	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.organization.countries.country.name	string	The name.
Progress Report URL	projects.project.progressReportLink	string	The progress report link.
Project URL	projects.project.projectLink	string	The project link.
Region	projects.project.region	string	The region.
Remaining	projects.project.remaining	string	The remaining.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifer.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
URL	projects.project.videos.video.url	string	The URL address.
Number Found	projects._numberFound	integer	The number of results found.

Get all projects for a country or region summary

Operation ID:: ProjectSummaryCountry

This action retrieves a subset of the full project information for all projects in a specific country or region. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.

Parameters

Name	Key	Required	Type	Description
Campaign ID	iso3166CountryCode	True	string	The unique identifier of the campaign.
Next Project ID	nextProjectId		string	The unique identifier of the next project.

Returns

Name	Path	Type	Description
Has Next	projects.hasNext	boolean	Whether there is a next page.
Next Project ID	projects.nextProjectId	integer	The identifier of the next project.
Active	projects.project.active	boolean	Whether it is active.
Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Country	projects.project.country	string	The country.
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.title	string	The description.
ID	projects.project.id	integer	The unique identifier.
Image Link	projects.project.imageLink	string	The image link.
Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
State	projects.project.organization.state	string	The state.
Postal Code	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	integer	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.organization.countries.country.name	string	The name.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifer.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
Number Found	projects._numberFound	integer	The number of results found.

Get all projects for a theme

Operation ID:: ProjectTheme

This action retrieves information for all projects in a specific theme. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.

Parameters

Name	Key	Required	Type	Description
Campaign ID	themeId	True	string	The unique identifier of the campaign.
Next Project ID	nextProjectId		string	The unique identifier of the next project.

Returns

Name	Path	Type	Description
Has Next	projects.hasNext	boolean	Whether there is a next page.
Next Project ID	projects.nextProjectId	integer	The identifier of the next project.
Active	projects.project.active	boolean	Whether it is active.
Activities	projects.project.activities	string	The activities.
Additional Documentation	projects.project.additionalDocumentation	string	Any additional documentation.
Approved Date	projects.project.approvedDate	string	The approved date.
Contact Address	projects.project.contactAddress	string	The contact's address.
Contact Address 2	projects.project.contactAddress2	string	The contact's address line 2.
Contact City	projects.project.contactCity	string	The contact's city.
Contact Country	projects.project.contactCountry	string	The contact's country.
Contact Name	projects.project.contactName	string	The contact's name.
Contact Postal	projects.project.contactPostal	string	The contact's postal.
Contact State	projects.project.contactState	string	The contact's state.
Contact Title	projects.project.contactTitle	string	The contact's title.
Contact URL	projects.project.contactUrl	string	The contact's URL.
Country	projects.project.country	string	The country.
Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Report Date	projects.project.dateOfMostRecentReport	string	The date of most recent report.
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.title	string	The description.
Funding	projects.project.funding	number	The funding.
Goal	projects.project.goal	integer	The goal.
ID	projects.project.id	integer	The unique identifier.
Gallery Size	projects.project.imageGallerySize	string	The image gallery size.
Image Link	projects.project.imageLink	string	The image link.
Image Link	projects.project.image.imagelink	array of object
URL	projects.project.image.imagelink.url	string	The URL address.
Size	projects.project.image.imagelink._size	string	The size
Title	projects.project.image.title	string	The title.
ID	projects.project.image._id	integer	The unique identifier.
Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Long Term Impact	projects.project.longTermImpact	string	The long term impact.
Modified Date	projects.project.modifiedDate	string	The modified date.
Need	projects.project.need	string	The need.
Notice	projects.project.notice	string	The notice.
Number of Donations	projects.project.numberOfDonations	integer	The number of donations.
Number of Reports	projects.project.numberOfReports	string	The number of reports.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
Postal Code	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	integer	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.organization.countries.country.name	string	The name.
Progress Report URL	projects.project.progressReportLink	string	The progress report link.
Project URL	projects.project.projectLink	string	The project link.
Region	projects.project.region	string	The region.
Remaining	projects.project.remaining	string	The remaining.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifer.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
URL	projects.project.videos.video.url	string	The URL address.
Number Found	projects._numberFound	integer	The number of results found.

Get all projects for a theme summary

Operation ID:: ProjectThemeSummary

This action retrieves a subset of the full project information for all projects in a specific theme. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.

Parameters

Name	Key	Required	Type	Description
Campaign ID	themeId	True	string	The unique identifier of the campaign.
Next Project ID	nextProjectId		integer	The unique identifier of the next project.

Returns

Name	Path	Type	Description
Has Next	projects.hasNext	boolean	Whether there is a next page.
Next Project ID	projects.nextProjectId	integer	The identifier of the next project.
Active	projects.project.active	boolean	Whether it is active.
Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Country	projects.project.country	string	The country.
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.title	string	The description.
ID	projects.project.id	integer	The unique identifier.
Image Link	projects.project.imageLink	string	The image link.
Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
State	projects.project.organization.state	string	The state.
Postal Code	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	integer	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.organization.countries.country.name	string	The name.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifer.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
Number Found	projects._numberFound	integer	The number of results found.

Get all projects for an organization

Operation ID:: ProjectOrganization

This action retrieves the full project information for all projects belonging to a specific organization. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.

Parameters

Name	Key	Required	Type	Description
Campaign ID	OrganizationId	True	string	The unique identifier of the campaign.
Next Project ID	nextProjectId		integer	The unique identifier of the next project.

Returns

Name	Path	Type	Description
Has Next	projects.hasNext	boolean	Whether there is a next page.
Next Project ID	projects.nextProjectId	integer	The identifier of the next project.
Active	projects.project.active	boolean	Whether it is active.
Activities	projects.project.activities	string	The activities.
Additional Documentation	projects.project.additionalDocumentation	string	Any additional documentation.
Approved Date	projects.project.approvedDate	string	The approved date.
Contact Address	projects.project.contactAddress	string	The contact's address.
Contact Address 2	projects.project.contactAddress2	string	The contact's address line 2.
Contact City	projects.project.contactCity	string	The contact's city.
Contact Country	projects.project.contactCountry	string	The contact's country.
Contact Name	projects.project.contactName	string	The contact's name.
Contact Postal	projects.project.contactPostal	string	The contact's postal.
Contact State	projects.project.contactState	string	The contact's state.
Contact Title	projects.project.contactTitle	string	The contact's title.
Contact URL	projects.project.contactUrl	string	The contact's URL.
Country	projects.project.country	string	The country.
Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Report Date	projects.project.dateOfMostRecentReport	string	The date of most recent report.
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.title	string	The description.
Funding	projects.project.funding	number	The funding.
Goal	projects.project.goal	integer	The goal.
ID	projects.project.id	integer	The unique identifier.
Gallery Size	projects.project.imageGallerySize	string	The image gallery size.
Image Link	projects.project.imageLink	string	The image link.
Image Link	projects.project.image.imagelink	array of object
URL	projects.project.image.imagelink.url	string	The URL address.
Size	projects.project.image.imagelink._size	string	The size
Title	projects.project.image.title	string	The title.
ID	projects.project.image._id	integer	The unique identifier.
Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Long Term Impact	projects.project.longTermImpact	string	The long term impact.
Modified Date	projects.project.modifiedDate	string	The modified date.
Need	projects.project.need	string	The need.
Notice	projects.project.notice	string	The notice.
Number of Donations	projects.project.numberOfDonations	integer	The number of donations.
Number of Reports	projects.project.numberOfReports	string	The number of reports.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
Postal Code	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	integer	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.organization.countries.country.name	string	The name.
Progress Report URL	projects.project.progressReportLink	string	The progress report link.
Project URL	projects.project.projectLink	string	The project link.
Region	projects.project.region	string	The region.
Remaining	projects.project.remaining	string	The remaining.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifer.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
URL	projects.project.videos.video.url	string	The URL address.
Number Found	projects._numberFound	integer	The number of results found.

Get all projects for an organization summary

Operation ID:: ProjectOrganizationSummary

Parameters

Name	Key	Required	Type	Description
Campaign ID	OrganizationId	True	string	The unique identifier of the campaign.
Next Project ID	nextProjectId		integer	The unique identifier of the next project.

Returns

Name	Path	Type	Description
Has Next	projects.hasNext	boolean	Whether there is a next page.
Next Project ID	projects.nextProjectId	integer	The identifier of the next project.
Active	projects.project.active	boolean	Whether it is active.
Activities	projects.project.activities	string	The activities.
Additional Documentation	projects.project.additionalDocumentation	string	Any additional documentation.
Approved Date	projects.project.approvedDate	string	The approved date.
Contact Address	projects.project.contactAddress	string	The contact's address.
Contact Address 2	projects.project.contactAddress2	string	The contact's address line 2.
Contact City	projects.project.contactCity	string	The contact's city.
Contact Country	projects.project.contactCountry	string	The contact's country.
Contact Name	projects.project.contactName	string	The contact's name.
Contact Postal	projects.project.contactPostal	string	The contact's postal.
Contact State	projects.project.contactState	string	The contact's state.
Contact Title	projects.project.contactTitle	string	The contact's title.
Contact URL	projects.project.contactUrl	string	The contact's URL.
Country	projects.project.country	string	The country.
Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Report Date	projects.project.dateOfMostRecentReport	string	The date of most recent report.
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.title	string	The description.
Funding	projects.project.funding	number	The funding.
Goal	projects.project.goal	integer	The goal.
ID	projects.project.id	integer	The unique identifier.
Gallery Size	projects.project.imageGallerySize	string	The image gallery size.
Image Link	projects.project.imageLink	string	The image link.
Image Link	projects.project.image.imagelink	array of object
URL	projects.project.image.imagelink.url	string	The URL address.
Size	projects.project.image.imagelink._size	string	The size
Title	projects.project.image.title	string	The title.
ID	projects.project.image._id	integer	The unique identifier.
Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Long Term Impact	projects.project.longTermImpact	string	The long term impact.
Modified Date	projects.project.modifiedDate	string	The modified date.
Need	projects.project.need	string	The need.
Notice	projects.project.notice	string	The notice.
Number of Donations	projects.project.numberOfDonations	integer	The number of donations.
Number of Reports	projects.project.numberOfReports	string	The number of reports.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
Postal Code	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	integer	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.organization.countries.country.name	string	The name.
Progress Report URL	projects.project.progressReportLink	string	The progress report link.
Project URL	projects.project.projectLink	string	The project link.
Region	projects.project.region	string	The region.
Remaining	projects.project.remaining	string	The remaining.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifer.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
URL	projects.project.videos.video.url	string	The URL address.
Number Found	projects._numberFound	integer	The number of results found.

Get all projects IDs

Operation ID:: ProjectIDs

This action retrieves all the available project IDs.

Returns

Name	Path	Type	Description
Project	projects.project	array of object
ID	projects.project.id	integer	The unique identifier.
Number Found	projects._numberFound	integer	The number of results found.

Get all projects summary

Operation ID:: ProjectSummaryGet

This action retrieves a subset of the full project information, for all projects. The result set, however, is limited to a maximum of 10 results for every request. If there are more results available, the response will return two extra elements and . Note that these two elements are not present if there are no more available results. The element indicates whether there are more results available and the element indicates the next project id to include in the query string to retrieve the next set of results.

Parameters

Name	Key	Required	Type	Description
Next Project ID	nextProjectId		integer	The unique identifier of the next project.

Returns

Name	Path	Type	Description
Has Next	projects.hasNext	boolean	Whether there is a next page.
Next Project ID	projects.nextProjectId	integer	The identifier of the next project.
Active	projects.project.active	boolean	Whether it is active.
Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Country	projects.project.country	string	The country.
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.title	string	The description.
ID	projects.project.id	integer	The unique identifier.
Image Link	projects.project.imageLink	string	The image link.
Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
State	projects.project.organization.state	string	The state.
Postal Code	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	integer	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.organization.countries.country.name	string	The name.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifer.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
Number Found	projects._numberFound	integer	The number of results found.

Get featured projects

Operation ID:: ProjectFeatured

This action retrieves information for featured projects. The result set will always return 10 results. The featured projects are rotated hourly based on GlobalGiving ranking, and a "randomization" algorithm.

Returns

Name	Path	Type	Description
Active	projects.project.active	boolean	Whether it is active.
Activities	projects.project.activities	string	The activities.
Additional Documentation	projects.project.additionalDocumentation	string	Any additional documentation.
Approved Date	projects.project.approvedDate	string	The approved date.
Contact Address	projects.project.contactAddress	string	The contact's address.
Contact Address 2	projects.project.contactAddress2	string	The contact's address line 2.
Contact City	projects.project.contactCity	string	The contact's city.
Contact Country	projects.project.contactCountry	string	The contact's country.
Contact Name	projects.project.contactName	string	The contact's name.
Contact Postal	projects.project.contactPostal	string	The contact's postal.
Contact State	projects.project.contactState	string	The contact's state.
Contact Title	projects.project.contactTitle	string	The contact's title.
Contact URL	projects.project.contactUrl	string	The contact's URL.
Country	projects.project.country	string	The country.
Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.title	string	The description.
Funding	projects.project.funding	number	The funding.
Goal	projects.project.goal	integer	The goal.
ID	projects.project.id	integer	The unique identifier.
Gallery Size	projects.project.imageGallerySize	string	The image gallery size.
Image Link	projects.project.imageLink	string	The image link.
Image Link	projects.project.image.imagelink	array of object
URL	projects.project.image.imagelink.url	string	The URL address.
Size	projects.project.image.imagelink._size	string	The size
Title	projects.project.image.title	string	The title.
ID	projects.project.image._id	integer	The unique identifier.
Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Long Term Impact	projects.project.longTermImpact	string	The long term impact.
Need	projects.project.need	string	The need.
Notice	projects.project.notice	string	The notice.
Number of Donations	projects.project.numberOfDonations	integer	The number of donations.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
Postal Code	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	integer	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.organization.countries.country.name	string	The name.
Progress Report URL	projects.project.progressReportLink	string	The progress report link.
Project URL	projects.project.projectLink	string	The project link.
Region	projects.project.region	string	The region.
Remaining	projects.project.remaining	string	The remaining.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifer.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
URL	projects.project.videos.video.url	string	The URL address.
Number Found	projects._numberFound	integer	The number of results found.

Get featured projects summary

Operation ID:: ProjectFeaturedSummary

This action retrieves summary information for featured projects. The result set will always return 10 results. The featured projects are rotated hourly based on GlobalGiving ranking, and a "randomization" algorithm.

Returns

Name	Path	Type	Description
Active	projects.project.active	boolean	Whether it is active.
Country	projects.project.country	string	The country.
Country Code	projects.project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.countries.country.name	string	The name.
Donation Option	projects.project.donationOptions.donationOption	array of object
Amount	projects.project.donationOptions.donationOption.amount	number	The amount.
Description	projects.project.donationOptions.donationOption.title	string	The description.
ID	projects.project.id	integer	The unique identifier.
Image Link	projects.project.imageLink	string	The image link.
Country Code	projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Active Projects	projects.project.organization.activeProjects	string	The active projects.
Address Line	projects.project.organization.addressLine1	string	The address line.
City	projects.project.organization.city	string	The city.
Country	projects.project.organization.country	string	The country.
ID	projects.project.organization.id	integer	The unique identifier.
Country Code	projects.project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Mission	projects.project.organization.mission	string	The mission.
Name	projects.project.organization.name	string	The name.
State	projects.project.organization.state	string	The state.
Postal Code	projects.project.organization.postal	string	The postal code.
Total Projects	projects.project.organization.totalProjects	string	The total projects.
URL	projects.project.organization.url	string	The URL address.
Theme	projects.project.organization.themes.theme	array of object
ID	projects.project.organization.themes.theme.id	integer	The unique identifier.
Name	projects.project.organization.themes.theme.name	string	The name.
Country	projects.project.organization.countries.country	array of object
Country Code	projects.project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	projects.project.organization.countries.country.name	string	The name.
Status	projects.project.status	string	The status.
Summary	projects.project.summary	string	The summary.
Theme	projects.project.themeName	string	The theme name.
Theme	projects.project.themes.theme	array of object
ID	projects.project.themes.theme.id	integer	The unique identifer.
Name	projects.project.themes.theme.name	string	The name.
Title	projects.project.title	string	The title.
Type	projects.project.type	string	The type.
Number Found	projects._numberFound	integer	The number of results found.

Get gift card designs

Operation ID:: GiftCardDesigns

When sending out email gift cards a gift card design must be specified. This action retrieves all the available GlobalGiving gift card designs to select from.

Returns

Name	Path	Type	Description
Active	giftCardDesigns.giftCardDesign.active	boolean	Whether it is active.
Address Required	giftCardDesigns.giftCardDesign.addressRequired	boolean	Whether the address is required.
Amount Required	giftCardDesigns.giftCardDesign.amountRequired	boolean	Whether the amount is required.
Card Type	giftCardDesigns.giftCardDesign.cardType	string	The card type.
Custom	giftCardDesigns.giftCardDesign.custom	boolean	Whether a custom design.
Email Required	giftCardDesigns.giftCardDesign.emailRequired	boolean	Whether email is required.
Gift Certificate	giftCardDesigns.giftCardDesign.giftCertificate	boolean	Whether a gift certificate.
ID	giftCardDesigns.giftCardDesign.id	integer	The unique identifier.
Image URL	giftCardDesigns.giftCardDesign.imageUrl	string	The image URL address.
Media	giftCardDesigns.giftCardDesign.media	string	The media type.
Name	giftCardDesigns.giftCardDesign.name	string	The name.
Preview Image URL	giftCardDesigns.giftCardDesign.previewImageUrl	string	The preview image URL address.
Quantity Required	giftCardDesigns.giftCardDesign.quantityRequired	boolean	Whether the quantity is required.
Send To Required	giftCardDesigns.giftCardDesign.sendToRequired	boolean	Whether the send to is required.
Thumbnail URL	giftCardDesigns.giftCardDesign.thumbnailUrl	string	The thumbnail URL address.

Get gift certificate details

Operation ID:: GiftCertificateDetails

This action allows a user to query the validity and details of a gift certificate.

Parameters

Name	Key	Required	Type	Description
Gift Certificate ID	giftcertid	True	string	The unique identifier of the gift certicate.

Returns

Name	Path	Type	Description
Currency Code	giftCertificate_detail.currencyCode	string	The currency code.
Expiration Date	giftCertificate_detail.expirationDate	string	The expiration date.
Gift Certificate Number	giftCertificate_detail.giftCertificateNumber	string	The gift certificate number.
Remaining Amount	giftCertificate_detail.remainingAmount	number	Remaining amount.
Valid	giftCertificate_detail.valid	boolean	Whether valid.

Get GlobalGiving themes

Operation ID:: Themes

This action retrieves all GlobalGiving themes.

Returns

Name	Path	Type	Description
Theme	themes.theme	array of object
ID	themes.theme.id	integer	The unique identifier.
Name	themes.theme.name	string	The name.

Get image gallery

Operation ID:: ImageGallery

This action retrieves any extra images for a specific project. When requesting full information, the indicates the number of images available. If this number is greater than zero you can access the extra images using This action.

Parameters

Name	Key	Required	Type	Description
Campaign ID	projectid	True	integer	The unique identifier of the campaign.

Returns

Name	Path	Type	Description
Image	images.image	array of object
Title	images.image.title	string	The title.
Image Link	images.image.imagelink	array of object
URL	images.image.imagelink.url	string	The URL address.
Size	images.image.imagelink._size	string	The size.
ID	images.image._id	integer	The unique identifier.

Get max third party ID

Operation ID:: ThirdPartyMax

This action retrieves the max (greatest alphabetically) third party transaction id associated with this API key. This is a secure request therefore, an access token (authentication) is required.

Returns

Name	Path	Type	Description
Currency Code	order.currencyCode	string	The currency code.
Newsletter Signup	order.signupForCharityNewsletter	boolean	Whether to signup for charity newsletter.
GG Newsletter Signup	order.signupForGGNewsletter	boolean	Whether to signup for GG newsletter.
Transaction ID	order.transactionId	string	The transaction unique identifier.

Get organization

Operation ID:: OrganizationGet

This action retrieves information for a specific organization.

Parameters

Name	Key	Required	Type	Description
Campaign ID	organizationid	True	string	The unique identifier of the campaign.

Returns

Name	Path	Type	Description
Active Project	organization.activeProjects	string	The active projects.
Address Line	organization.addressLine1	string	The address line.
Address Line 2	organization.addressLine2	string	The address line 2.
City	organization.city	string	The city.
Country	organization.country	string	The country.
EIN	organization.ein	string	The EIN number.
ID	organization.id	string	The unique identifier.
Country Code	organization.iso3166CountryCode	string	The country code in ISO3166 format.
Logo URL	organization.logoUrl	string	The logo URL address.
Mission	organization.mission	string	The mission.
Name	organization.name	string	The name.
Postal Code	organization.postal	string	The postal code.
State	organization.state	string	The state.
Total Project	organization.totalProjects	integer	The total number of projects.
URL	organization.url	string	The URL address.
Theme	organization.themes.theme	array of object
ID	organization.themes.theme.id	integer	The unique identifier.
Name	organization.themes.theme.name	string	The name.
Country	organization.countries.country	array of object
Country Code	organization.countries.country.iso3166CountryCode	string	The ISO3166 country code.
Name	organization.countries.country.name	string	The name.

Get outstanding invoices

Operation ID:: InvoiceOutstanding

This action retrieves all outstanding invoices not yet reconciled. This is a secure request therefore, an access token (authentication) is required.

Returns

Name	Path	Type	Description
Invoice	invoices.invoice	array of object
Amount	invoices.invoice.amount	number	The amount.
Datetime	invoices.invoice.datetime	string	The datetime.
Email	invoices.invoice.email	string	The email address.
ID	invoices.invoice.project.id	integer	The unique identifier.
Invoice Number	invoices.invoice.invoiceNumber	string	The invoice number.

Get region project counts

Operation ID:: RegionProjectCount

This action retrieves all regions and countries with their associated project counts.

Returns

Name	Path	Type	Description
Country	regions.region.countries.country	array of object
Country Code	regions.region.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	regions.region.countries.country.name	string	The name.
Project Count	regions.region.countries.country.projectCount	integer	The project count.
Name	regions.region.name	string	The name.

Get region project counts for a specific region

Operation ID:: ProjectRegionCount

This action retrieves project counts for a specific region.

Parameters

Name	Key	Required	Type	Description
Campaign ID	regionname	True	string	The unique identifier of the campaign.

Returns

Name	Path	Type	Description
Country	regions.region.countries.country	array of object
Country Code	regions.region.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	regions.region.countries.country.name	string	The name.
Project Count	regions.region.countries.country.projectCount	integer	The project count.
Name	regions.region.name	string	The name.

Get regions

Operation ID:: RegionGet

This action retrieves all regions.

Returns

Name	Path	Type	Description
Region	regions.region	array of object
Name	regions.region.name	string	The name.

Get specific project

Operation ID:: ProjectGetA

This action displays information for a specific project.

Parameters

Name	Key	Required	Type	Description
Campaign ID	projectid	True	integer	The unique identifier of the campaign.

Returns

Name	Path	Type	Description
Active	project.active	boolean	Whether active.
Activities	project.activities	string	The activities.
Additional Documentation	project.additionalDocumentation	string	Any additional documentation.
Approved Date	project.approvedDate	string	The approved date.
Contact Address	project.contactAddress	string	The contact's address.
Contact City	project.contactCity	string	The contact's city.
Contact Country	project.contactCountry	string	The contact's country.
Contact	project.contactName	string	The contact's name.
Contact Postal	project.contactPostal	integer	The contact's postal.
Contact State	project.contactState	string	The contact's state.
Contact Title	project.contactTitle	string	The contact's title.
Contact URL	project.contactUrl	string	The contact's URL address.
Country Code	project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	project.countries.country.name	string	The name.
Country	project.country	string	The country.
Country Code	project.iso3166CountryCode	string	The country code in ISO3166 format.
Donation Option	project.donationOptions.donationOption	array of object
Amount	project.donationOptions.donationOption.amount	number	The amount.
Description	project.donationOptions.donationOption.title	string	The description.
Funding	project.funding	number	The funding.
Goal	project.goal	integer	The goal.
ID	project.id	string	The unique identifier.
Image Gallery Size	project.imageGallerySize	string	The image gallery size.
Image Link	project.imageLink	string	The image link.
Image	project.imageSizeOptions.image	array of object
URL	project.imageSizeOptions.image.url	string	The URL address.
Size	project.imageSizeOptions.image._size	string	The size.
Latitude	project.latitude	string	The latitude.
Long Term Impact	project.longTermImpact	string	The long term impact.
Longitude	project.longitude	string	The longitude.
Need	project.need	string	The need.
Notice	project.notice	string	The notice.
Number of Donations	project.numberOfDonations	integer	The number of donations.
Address Line	project.organization.addressLine1	string	The address line.
City	project.organization.city	string	The city.
Country	project.organization.country	string	The country.
ID	project.organization.id	integer	The unique identifier.
Country Code	project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Logo URL	project.organization.logoUrl	string	The logo URL address.
Name	project.organization.name	string	The name.
Postal Code	project.organization.postal	string	The postal code.
URL	project.organization.url	string	The URL address.
Progress Report Link	project.progressReportLink	string	The progress report link.
Project Link	project.projectLink	string	The project link.
Remaining	project.remaining	string	The remaining.
Status	project.status	string	The status.
Summary	project.summary	string	The summary.
Theme Name	project.themeName	string	The theme name.
Theme	project.themes.theme	array of object
ID	project.themes.theme.id	integer	The unique identifier.
Name	project.themes.theme.name	string	The name.
Title	project.title	string	The title.

Get specific project summary

Operation ID:: ProjectSummary

This action displays a subset of the full project information for a specific project.

Parameters

Name	Key	Required	Type	Description
Campaign ID	projectid	True	integer	The unique identifier of the campaign.

Returns

Name	Path	Type	Description
Active	project.active	boolean	Whether active.
Country	project.country	string	The country.
Country Code	project.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	project.countries.country.name	string	The name.
Donation Option	project.donationOptions.donationOption	array of object
Amount	project.donationOptions.donationOption.amount	number	The amount.
Description	project.donationOptions.donationOption.title	string	The description.
ID	project.id	integer	The unique identifier.
Image Link	project.imageLink	string	The image link.
Country Code	project.iso3166CountryCode	string	The country code in ISO3166 format.
Address Line	project.organization.addressLine1	string	The address line.
City	project.organization.city	string	The city.
Country	project.organization.country	string	The country.
ID	project.organization.id	integer	The unique identifier.
Country Code	project.organization.iso3166CountryCode	string	The country code in ISO3166 format.
Name	project.organization.name	string	The name.
Postal Code	project.organization.postal	string	The postal code.
URL	project.organization.url	string	The URL address.
Theme	project.organization.themes.theme	array of object
ID	project.organization.themes.theme.id	integer	The unique identifer.
Name	project.organization.themes.theme.name	string	The name.
Country	project.organization.countries.country	array of object
Country Code	project.organization.countries.country.iso3166CountryCode	string	The country code in ISO3166 format.
Name	project.organization.countries.country.name	string	The name.
Status	project.status	string	The status.
Summary	project.summary	string	The summary.
Theme	project.themes.theme	array of object
ID	project.themes.theme.id	integer	The unique identifier.
Name	project.themes.theme.name	string	The name.
Theme Name	project.themeName	string	The theme name.
Title	project.title	string	The title.
Type	project.type	string	The type.

Get themes with project IDs

Operation ID:: ThemeProject

This action retrieves all GlobalGiving themes with their associated project IDs.

Returns

Name	Path	Type	Description
Theme	themes.theme	array of object
ID	themes.theme.id	integer	The unique identifier.
Name	themes.theme.name	string	The name.
project	themes.theme.projects.project	array of object	Project.
ID	themes.theme.projects.project.id	integer	The unique identifier.
Number Found	themes.theme.projects._numberFound	integer	The number found.
Text	themes.theme.projects.__text	string	The text

Order a gift certificate

Operation ID:: GiftCertificateOrder

This action allows a user to submit an order for a gift certificate without submitting payment details. This allows GlobalGiving the ability to immediately generate gift certificates with the understanding that reconciliation of the order will take place at a later date.

Parameters

Name	Key	Type	Description
Is Test	is_test	boolean	Whether action is a test.
Referral Code	refcode	integer	The referral code.
Amount	amount	number	The amount.
Third-party ID	thirdPartyIdentifier	string	The third-party identifier.
Currency Code	currencyCode	string	The currency code.
Expiration Date	expirationDate	string	The expiration date.

Returns

Name	Path	Type	Description
Gift Certificate Number	giftCertificate_detail.giftCertificateNumber	string	The gift certificate number.
Remaining Amount	giftCertificate_detail.remainingAmount	number	Remaining amount.
Third-party ID	giftCertificate_detail.thirdPartyIdentifier	string	The third-party identifier.
Currency Code	giftCertificate_detail.currencyCode	string	The currency code.
Redeem URL	giftCertificate_detail.redeemUrl	string	The redeem URL address.
Expiration Date	giftCertificate_detail.expirationDate	string	The expiration date.

Search projects

Operation ID:: ProjectSearch

This action allows searching for projects using keywords.

Parameters

Name	Key	Type	Description
Query	q	string	The query string.
Start	start	integer	The starting number.
Filter	filter	string	The filter string.

Returns

Name	Path	Type	Description
Name	search.request.filters.filter.name	string	The name.
Value	search.request.filters.filter.value	string	The value.
Query	search.request.q	string	The query string.
Start	search.request.start	integer	The start.
Summary	search.request.summary	string	The summary.
Active	search.response.projects.project.active	boolean	Whether active.
Activities	search.response.projects.project.activities	string	The activities.
Additional Documentation	search.response.projects.project.additionalDocumentation	string	Any additional documentation.
Approved Date	search.response.projects.project.approvedDate	string	The approved date.
Contact Address	search.response.projects.project.contactAddress	string	The contact's address.
Contact Address 2	search.response.projects.project.contactAddress2	string	The contact's address2.
Contact City	search.response.projects.project.contactCity	string	The contact's city.
Contact Country	search.response.projects.project.contactCountry	string	The contact's country.
Contact email	search.response.projects.project.contactEmail	string	The contact's email.
Contact	search.response.projects.project.contactName	string	The contact's name.
Contact Phone	search.response.projects.project.contactPhone	string	The contact's phone.
Contact Postal	search.response.projects.project.contactPostal	integer	The contact's postal.
Contact State	search.response.projects.project.contactState	string	The contact's state.
Contact URL	search.response.projects.project.contactUrl	string	The contact's URL address.
Country	search.response.projects.project.country	string	The country.
Donation Option.	search.response.projects.project.donationOptions.donationOption	array of object
Amount	search.response.projects.project.donationOptions.donationOption.amount	number	The amount.
Description	search.response.projects.project.donationOptions.donationOption.description	string	The description.
Funding	search.response.projects.project.funding	number	The funding.
Goal	search.response.projects.project.goal	integer	The goal.
ID	search.response.projects.project.id	integer	The unique identifier.
Image Gallery Size	search.response.projects.project.imageGallerySize	string	The image gallery size.
Image Link	search.response.projects.project.imageLink	string	The image link.
Image Link.	search.response.projects.project.image.imagelink	array of object
URL	search.response.projects.project.image.imagelink.url	string	The URL address.
Size	search.response.projects.project.image.imagelink._size	string	The size
Title	search.response.projects.project.image.title	string	The title.
ID	search.response.projects.project.image._id	string	The unique identifier.
Country Code	search.response.projects.project.iso3166CountryCode	string	The country code in ISO3166 format.
Long Term Impact	search.response.projects.project.longTermImpact	string	The long term impact.
Need	search.response.projects.project.need	string	The need.
Number of Donations	search.response.projects.project.numberOfDonations	integer	The number of donations.
Address Line	search.response.projects.project.organization.addressLine1	string	The address line.
City	search.response.projects.project.organization.city	string	The city.
Country	search.response.projects.project.organization.country	string	The country.
ID	search.response.projects.project.organization.id	string	The unique identifier.
Name	search.response.projects.project.organization.name	string	The name.
Postal Code	search.response.projects.project.organization.postal	string	The postal code.
Progress Report Link	search.response.projects.project.progressReportLink	string	The progress report link.
Project Link	search.response.projects.project.projectLink	string	The project link.
Region	search.response.projects.project.region	string	The region.
Remaining	search.response.projects.project.remaining	string	The remaining.
Status	search.response.projects.project.status	string	The status.
Summary	search.response.projects.project.summary	string	The summary.
Theme Name	search.response.projects.project.themeName	string	The theme name.
Title	search.response.projects.project.title	string	The title.
Start	search.response._start	integer	The start.
Number Found	search.response._numberFound	integer	The number found.

Send a gift card

Operation ID:: GiftCardSend

This action allows a user to send a gift card.

Parameters

Name	Key	Type	Description
Is Test	is_test	boolean	Whether action is a test.
Referral Code	refcode	integer	The referral code.
Transaction ID	transactionId	string	The transaction unique identifier.
Email	email	string	The email address.
Amount	amount	number	The amount.
First Name	firstname	string	The first name.
Last Name	lastname	string	The last name.
Address	address	string	The address.
Address Line 2	address2	string	The address line 2.
City	city	string	The city.
State	state	string	The state.
Country Code	iso3166CountryCode	string	The country code in ISO3166 format.
Zip Code	zip	integer	The zip code.
Credit Card Number	creditCardNumber	integer	Credit card number.
Security Code	securityCode	integer	The security code.
Expiry Date Month	expiryDateMonth	integer	The expiry date month.
Expiry Date Year	expiryDateYear	integer	The expiry date year.
ID	id	integer	The unique identifier.
Date to Send	dateToSend	string	The date to send.
First Name	firstname	string	The first name.
Last Name	lastname	string	The last name.
Email	email	string	The email address.
Phone	phone	string	The phone number.
Recipient	to	string	The recipient.
Sender	from	string	The sender.
Message	message	string	The message.

Returns

Name	Path	Type	Description
Amount	giftCard.amount	number	The amount.
Charged Amount	giftCard.chargedAmount	number	The charged amount.
Currency Code	giftCard.currencyCode	string	The currency code.
Date-time	giftCard.datetime	string	The date-time.
Email	giftCard.email	string	The email address.
Referral Code	giftCard.refcode	integer	The referral code.
Newsletter Signup	giftCard.signupForCharityNewsletter	boolean	Whether to signup for charity newsletter.
GG Newsletter Signup	giftCard.signupForGGNewsletter	boolean	Whether to signup for GG newsletter.
Transaction ID	giftCard.transactionId	string	The transaction unique identifier.
Checked Out	giftCard.checkedOut	boolean	Whether checked out.
Currency Code	giftCard.giftCertificate_detail.currencyCode	string	The currency code.
Gift Certificate Number	giftCard.giftCertificate_detail.giftCertificateNumber	string	The gift certificate number.
Remaining Amount	giftCard.giftCertificate_detail.remainingAmount	number	The remaining amount.
First Name	giftCard.payment_detail.firstname	string	The first name.
Last Name	giftCard.payment_detail.lastname	string	The last name.
Address	giftCard.payment_detail.address	string	The address.
Address Line 2	giftCard.payment_detail.address2	string	The address line 2.
City	giftCard.payment_detail.city	string	The city.
State	giftCard.payment_detail.state	string	The state.
Country Code	giftCard.payment_detail.iso3166CountryCode	string	The country code in ISO3166 format.
Zip Code	giftCard.payment_detail.zip	integer	The zip code.
Credit Card Number	giftCard.payment_detail.creditCardNumber	integer	The credit card number.
Security Code	giftCard.payment_detail.securityCode	integer	The security code.
Expiry Date Month	giftCard.payment_detail.expiryDateMonth	integer	The expiry date month.
Expiry Date Year	giftCard.payment_detail.expiryDateYear	integer	The expiry date year.
Currency Code	giftCard.receipt.currencyCode	string	The currency code.
Receipt Number	giftCard.receipt.receiptNumber	string	The receipt number.
Tax Deductible Amount	giftCard.receipt.taxDeductibleContributionAmount	number	The tax deductible contribution amount.
Total Amount Billed	giftCard.receipt.totalAmountBilled	number	The total amount billed.
ID	giftCard.giftCardDesign.id	integer	The unique identifier.
Date to Send	giftCard.giftCard_detail.dateToSend	string	The date to send.
First Name	giftCard.giftCard_detail.firstname	string	The first name.
Last Name	giftCard.giftCard_detail.lastname	string	The last name.
Email	giftCard.giftCard_detail.email	string	The email address.
Phone	giftCard.giftCard_detail.phone	string	The phone number.
Recipient	giftCard.giftCard_detail.to	string	The recipient.
Sender	giftCard.giftCard_detail.from	string	The sender.
Message	giftCard.giftCard_detail.message	string	The message.

Submit a donation

Operation ID:: DonationSubmit

This action allows a user to submit a donation request.

Parameters

Name	Key	Type	Description
Is Test	is_test	boolean	Whether action is a test.
Referral Code	refcode	integer	The referral code.
Transaction ID	transactionId	string	The transaction unique identifier.
Email	email	string	The email address.
Amount	amount	number	The amount.
ID	id	integer	The unique identifier.
GG Newsletter Signup	signupForGGNewsletter	boolean	Whether to signup for GG newsletter.
Newsletter Signup	signupForCharityNewsletter	boolean	Whether to signup for charity newsletter.
First Name	firstname	string	The first name.
Last Name	lastname	string	The last name.
Address	address	string	The address.
Address Line 2	address2	string	The address line 2.
City	city	string	The city.
State	state	string	The state.
Country Code	iso3166CountryCode	string	The country code in ISO3166 format.
Payment Gateway	paymentGateway	string	The payment gateway.
Payment Gateway Key	paymentGatewayKey	string	The payment gateway key.
Payment Gateway Nonce	paymentGatewayNonce	string	The payment gateway nonce.
Donor's IP	ipAddress	string	The donor's IP address.
User Agent	userAgent	string	The donor's user agent.

Returns

Name	Path	Type	Description
Amount	donation.amount	number	The amount.
Charged Amount	donation.chargedAmount	number	The charged amount.
Currency Code	donation.currencyCode	string	The currency code.
Date-time	donation.datetime	string	The date-time.
Email	donation.email	string	The email address.
Funding	donation.project.funding	number	The funding.
Goal	donation.project.goal	integer	The goal.
ID	donation.project.id	integer	The unique identifier.
Number of Donations	donation.project.numberOfDonations	integer	The number of donations.
Progress Report URL	donation.project.progressReportLink	string	The progress report link.
Project URL	donation.project.projectLink	string	The project link.
Remaining	donation.project.remaining	string	The remaining.
Newsletter Signup	donation.signupForCharityNewsletter	boolean	Whether to signup for charity newsletter.
GG Newsletter Signup	donation.signupForGGNewsletter	boolean	Whether to signup for GG newsletter.
Referral Code	donation.refcode	integer	The referral code.
Transaction ID	donation.transactionId	string	The transaction unique identifier.
Checked Out	donation.checkedOut	boolean	Whether checked out.
Currency Code	donation.giftCertificate_detail.currencyCode	string	The currency code.
Gift Certificate Number	donation.giftCertificate_detail.giftCertificateNumber	string	The gift certificate number.
Redeemed Amount	donation.giftCertificate_detail.redeemedAmount	number	The redeemed amount.
Remaining Amount	donation.giftCertificate_detail.remainingAmount	number	The remaining amount.
Receipt Number	donation.receipt.receiptNumber	string	The receipt number.
Tax Deductible Amount	donation.receipt.taxDeductibleContributionAmount	number	The tax deductible contribution amount.
Total Amount Billed	donation.receipt.totalAmountBilled	number	The total amount billed.