IO Docs: API Documentation

IO Docs

You can use IO Docs to make API calls directly against our sandbox environment, allowing you to test the calls you need for your live application.

You can also view our written documentation.

Please select one of the API packages from the list below.

Select an Interactive Documentation
Charity developer APIs
Event developer APIs
Fundraiser developer APIs

You can test the various APIs available under the Charity developer package from here

You can test the various APIs available under the Event developer package from here

You can test the various APIs available under the Fundraiser developer package from here

OAuth 2.0 Flow:

Existing Client Credentials:

API Key:

App/Key: Manually provide key information

Shared Secret:

Client ID:

Client Secret:

Client ID:

Client Secret:

Username:

Password:

Client ID:

Client Secret:

Authorization Code:

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

APIs in this package

List Methods

Expand Methods

GET Fundraiser details fundraisers/v1/account/:resourceId

Retrieve details for a fundraiser based on their API reference

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML
:resourceId		string	Resource Id (API reference) of the fundraiser

GET Validate fundraiser URL fundraisers/v1/urls/:urlToCheck

Checks if the requested fundraiser URL is available, and if not, suggests alternatives

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML
:urlToCheck		string	Fundraiser URL to check

GET Validate team URL fundraisers/v1/urls/teams/:urlToCheck

Checks if the requested team URL is available, and if not, suggests alternatives

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML
:urlToCheck		string	Team URL to check

GET Country code lookup fundraisers/v1/countries

Fetch a list of all countries in our database

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML

GET Address lookup fundraisers/v1/postcode/:lookupValue

Performs a UK postcode lookup

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML
:lookupValue		string	Postcode to look up

POST Create fundraiser account fundraisers/v1/newaccount

Create a new fundraiser account

Parameter	Type	Description
Content-Type	string	Input format as JSON or XML
Accept	string	Output format as JSON or XML
redirect_uri	string	The Redirect URI configured in your application

Request Body

GET Activity lookup fundraisers/v1/activities

Fetch activity codes that can be used to create new fundraising pages

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML

GET Event search events/v1/search

Search for an event by name and/or date

Parameter	Type	Description
Accept	string	Output format as JSON or XML
name	string	Event name to search for
date	string	Event date (in YYYYMM format) to search for

POST Create fundraiser page fundraisers/v1/account/secure/:resourceId/newpage

Create a new fundraising page for an existing fundraiser

Parameter	Type	Description
Content-Type	string	Input format as JSON or XML
Accept	string	Output format as JSON or XML
Authorization	string	Access Token. Format is: Bearer yourAccessToken (Don't forget to add the word 'Bearer ' before the access token)
:resourceId	string	The resource Id (API reference) of the fundraiser you are creating this page for

Request Body

GET Event summary events/v1/account/:eventResourceId/charitysummary/:charityResourceId

Retrieve a charity's donation summary for an event

Parameter	Type	Description
Accept	string	Output format as JSON or XML
:eventResourceId	string	Resource Id (API reference) of the event
:charityResourceId	string	Resource Id (API reference) of the charity

GET Event fundraisers events/v1/account/:eventResourceId/charities/:charityResourceId/pages

Retrieve a charity's fundraising pages for an event

Parameter	Type	Description
Accept	string	Output format as JSON or XML
:eventResourceId	string	Resource Id (API reference) of the event
:charityResourceId	string	Resource Id (API reference) of the charity
sortOrder	string	Sort order
sortField	string	Field to sort on
numRecords	int	Number of records to return
startRecordNum	int	Offset i.e. Start record number of the result set

GET Charity fundraisers charities/v1/account/:charityResourceId/pages

Retrieve all fundraising pages for a charity

Parameter	Type	Description
Accept	string	Output format as JSON or XML
:charityResourceId	string	Resource Id (API reference) of the charity
sortOrder	string	Sort order
sortField	string	Field to sort on
numRecords	int	Number of records to return
startRecordNum	int	Offset i.e. Start record number of the result set

APIs in this package

List Methods

Expand Methods

GET Fundraiser details fundraisers/v1/account/:resourceId

Retrieve details for a fundraiser based on their API reference

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML
:resourceId		string	Resource Id (API reference) of the fundraiser

GET Charity search charities/v1/search

Search for a charity by name

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML
name		string	Charity name to search for

GET Validate fundraiser URL fundraisers/v1/urls/:urlToCheck

Checks if the requested fundraiser URL is available, and if not, suggests alternatives

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML
:urlToCheck		string	Fundraiser URL to check

GET Validate team URL fundraisers/v1/urls/teams/:urlToCheck

Checks if the requested team URL is available, and if not, suggests alternatives

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML
:urlToCheck		string	Team URL to check

GET Country code lookup fundraisers/v1/countries

Fetch a list of all countries in our database

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML

GET Address lookup fundraisers/v1/postcode/:lookupValue

Performs a UK postcode lookup

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML
:lookupValue		string	Postcode to look up

POST Create fundraiser account fundraisers/v1/newaccount

Create a new fundraiser account

Parameter	Type	Description
Content-Type	string	Input format as JSON or XML
Accept	string	Output format as JSON or XML
redirect_uri	string	The Redirect URI configured in your application

Request Body

GET Activity lookup fundraisers/v1/activities

Fetch activity codes that can be used to create new fundraising pages via the API

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML

POST Create fundraiser page fundraisers/v1/account/secure/:resourceId/newpage

Create a new fundraising page for an existing fundraiser

Parameter	Type	Description
Content-Type	string	Input format as JSON or XML
Accept	string	Output format as JSON or XML
Authorization	string	Access Token. Format is: Bearer yourAccessToken (Don't forget to add the word 'Bearer ' before the access token)
:resourceId	string	The resource Id (API reference) of the fundraiser you are creating this page for

Request Body

GET Event summary events/v1/account/:eventResourceId/summary

Retrieve donation summary for an event

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML
:eventResourceId		string	Resource Id (API reference) of the event

GET Event fundraisers events/v1/account/:eventResourceId/pages

Retrieve all fundraisers and their fundraising pages for an event

Parameter	Type	Description
Accept	string	Output format as JSON or XML
:eventResourceId	string	Resource Id (API reference) of the event
sortOrder	string	Sort order
sortField	string	Field to sort on
numRecords	int	Number of records to return
startRecordNum	int	Offset i.e. Start record number of the result set

GET Charity details charities/v1/account/:charityResourceId

Retrieve details for a charity based on the API reference of the charity

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML
:charityResourceId		string	Resource Id (API reference) of the charity

APIs in this package

List Methods

Expand Methods

GET Fundraiser search fundraisers/v1/search

Search for a fundraiser by surname and optionally forename

Parameter	Type	Description
Accept	string	Output format as JSON or XML
surname	string	Surname to search for
forename	string	Forename to search for

GET Fundraiser details fundraisers/v1/account/:resourceId

Retrieve details for a fundraiser based on their API reference

Parameter	Value	Type	Description
Accept		string	Output format as JSON or XML
:resourceId		string	Resource Id (API reference) of the fundraiser

GET Fundraising page details fundraisers/v1/account/:resourceId/pages/:pageId

Retrieve a fundraising page based on a fundraiser's API reference and the page id

Parameter	Type	Description
Accept	string	Output format as JSON or XML
:resourceId	string	Resource Id (API reference) of the fundraiser
:pageId	int	Id of the page to retrieve

IO Docs: API Documentation

APIs in this package List Methods Expand Methods

Request Body

Request Body

APIs in this package List Methods Expand Methods

Request Body

Request Body

APIs in this package List Methods Expand Methods

APIs in this package

List Methods

Expand Methods

APIs in this package

List Methods

Expand Methods

APIs in this package

List Methods

Expand Methods