JustGiving API

GetCampaignByShortName

Uri /{appId}/v1/campaign/byshortname/{shortName}
Verb GET
Auth No

Http

To request: https://api.justgiving.com/{appId}/v1/campaign/byshortname/{shortName}
Perform the following HTTP request:

GET /{appId}/v1/campaign/byshortname/{shortName} HTTP/1.1
Host: api.justgiving.com
Content-type: application/json

Url Parameters

shortName (String)

Response Examples

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
    "BrandingGuid": null,
    "CampaignGuid": "1a7168a4-7c93-4ac9-862f-f88801364f43",
    "Charities": null,
    "Currency": {
        "CurrencyCode": "gbp",
        "CurrencySymbol": "£"
    },
    "DonationSummary": {
        "DirectDonationAmount": 1000.0,
        "DirectDonationGiftAid": 100,
        "FundraiserRaisedAmount": 153,
        "NumberOfDirectDonations": 10,
        "NumberOfFundraiserDonations": 100,
        "OfflineAmountUpdated": null,
        "TotalAmount": 1253.00,
        "TotalGiftAid": 0,
        "TotalNumberOfDonations": 100,
        "offlineAmount": 1
    },
    "EndDate": null,
    "EventRegistrationLink": null,
    "Fundraising": null,
    "LandingPageUrl": null,
    "OfflineAmount": 0,
    "OfflineAmountUpdated": null,
    "ShortName": "shortname",
    "StartDate": null,
    "Status": "Active",
    "Story": "story",
    "Summary": "summary",
    "TargetAmount": 10000,
    "ThankYouMessage": null,
    "Title": null
}
campaignGuid (Guid)
The campaign guid, unique to the campaign.
shortName (String)
title (String)
summary (String)
story (String)
startDate (DateTime)
endDate (DateTime)
brandingGuid (String)
offlineAmount (Decimal)
offlineAmountUpdated (Object)
currency (CurrencyDto)
status (String)
landingPageUrl (Object)
eventRegistrationLink (Object)
thankYouMessage (String)
targetAmount (Decimal)
charities (Collection of CharityDto)
fundraising (PublicFundraisingDto)
donationSummary (CampaignDonationsummary)
errorMessage (String)