- Previous: Create fundraiser account
- Up: Introduction
- Next: Event search
Activity lookup
Page and account creation APIs are now unavailable so please consider your use of our APIs and how this affects you. All other APIs will be available until 18 February. If you have any questions please take a look at our Q&A.
Read our Q&A
Documentation
Activity lookup
This API returns a list of fundraising activities and their codes. These are required when creating a fundraising page that isn't linked to an event.
As this data rarely changes you may wish to retrieve the list from the IO Docs.
URL
Operation type: GET
https://api.virginmoneygiving.com/fundraisers/v1/activities?api_key={your API key}
Parameter | Required | Data type | Description |
---|---|---|---|
api_key | True | Varchar (24) | This is your key that allows you access to the VMG APIs. |
Response
Outcome | Further information |
---|---|
Success |
Activity details in the following format:
|
Error |
If no activity codes are found the following is returned:
Click here for a full list of API error codes. |
Response description
Data item | Data type | Description |
---|---|---|
activityCode | Varchar(10) | This activity code is required by the fundraising page creation API. |
activityDescription | Varchar(255) | This is the description associated with the charity code. |
reasonCode | Varchar(10) | This is provided for future proofing and at present will always return ‘CHALLENGE’. |
XML response example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <activitytypes> <activitytype> <activityCode>028</activityCode> <activityDescription>Adrenalin rush</activityDescription> <reasonCode>CHALLENGE</reasonCode> </activitytype> <activitytype> <activityCode>029</activityCode> <activityDescription>Cycling</activityDescription> <reasonCode>CHALLENGE</reasonCode> </activitytype>
JSON response example
{ "activityTypes": [{ "activityCode": "028", "activityDescription": "Adrenalin rush", "reasonCode": "CHALLENGE" }, { "activityCode": "029", "activityDescription": "Cycling", "reasonCode": "CHALLENGE" },
- Previous: Create fundraiser account
- Up: Introduction
- Next: Event search
Docs Navigation
- Introduction
- Getting started
- Fundraiser search
- Fundraiser details
- Fundraiser details V2
- Fundraising page details
- Fundraising page details V2
- Charity search
- Validate URL
- Country code lookup
- Address lookup
- Account Exists
- Create fundraiser account
- Activity lookup
- Event search
- Create fundraiser page
- Event summary
- Event fundraisers
- Event Fundraisers V2
- Event fundraisers 2
- Event fundraisers 2 V2
- Charity fundraisers
- Charity fundraisers V2
- Charity details
- Authentication
- Useful information
- Error codes
- Glossary
- Software development kit