v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Campaigns

get campaign profile

Return the campaign profile <br><br> The campaign profile is the top level profile for all profiles in the campaign. It is hidden from the fundraising website, but will have the same name, path, and goal as your campaign. All profiles that don't otherwise belong to a team belong to the campaign profile, and their parentUuid field will refer to the campaign profile.

For custom components:

RaiselyComponents.api.one('campaigns', '{campaign}').get('profile', params = {}, headers = {}) => Promise<{result}>

:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper

get/campaigns/{campaign}/profile

Path parameters

campaignstring required

The uuid, path or domain of the campaign to associate with the request

Headers

Authorizationstring

A valid HTTP Bearer token, required to access private records.

Response

The created Profile record

Example response

{
  "data": {
    "activityTotal": 2625,
    "activityTotalPercent": 2625,
    "campaignDisplayTotal": 2625,
    "createdAt": "2020-12-03T06:52:46.330Z",
    "currency": "AUD",
    "description": "I believe in a better world",
    "donationCount": 12345,
    "donationRecordCount": 12345,
    "exerciseGoal": 12345,
    "exerciseGoalTime": 12345,
    "exerciseTotal": 2625,
    "exerciseTotalTime": 2625,
    "fundraiserTheme": "birthday",
    "goal": 100050,
    "individualProfileCount": 12345,
    "isCampaignProfile": true,
    "name": "Bob D.",
    "nonSelfDonationTotal": 2625,
    "organisationProfileCount": 12345,
    "paid": true,
    "path": "bobd",
    "photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
    "public": {
      "fieldA": "one",
      "fieldB": "yes"
    },
    "selfDonationTotal": 2625,
    "status": "ACTIVE",
    "subscriptionCount": 12345,
    "teamProfileCount": 12345,
    "type": "INDIVIDUAL",
    "uniqueDonors": 12345,
    "updatedAt": "2020-12-03T06:52:46.330Z",
    "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "teamProfile": {
      "activityTotal": 2625,
      "activityTotalPercent": 2625,
      "campaignDisplayTotal": 2625,
      "createdAt": "2020-12-03T06:52:46.330Z",
      "currency": "AUD",
      "description": "I believe in a better world",
      "donationCount": 12345,
      "donationRecordCount": 12345,
      "exerciseGoal": 12345,
      "exerciseGoalTime": 12345,
      "exerciseTotal": 2625,
      "exerciseTotalTime": 2625,
      "fundraiserTheme": "birthday",
      "goal": 100050,
      "individualProfileCount": 12345,
      "isCampaignProfile": true,
      "name": "Bob D.",
      "nonSelfDonationTotal": 2625,
      "organisationProfileCount": 12345,
      "paid": true,
      "path": "bobd",
      "photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
      "private": {
        "fieldA": "one",
        "fieldB": "yes"
      },
      "public": {
        "fieldA": "one",
        "fieldB": "yes"
      },
      "selfDonationTotal": 2625,
      "shared": true,
      "status": "ACTIVE",
      "subscriptionCount": 12345,
      "teamProfileCount": 12345,
      "type": "INDIVIDUAL",
      "uniqueDonors": 12345,
      "updatedAt": "2020-12-03T06:52:46.330Z",
      "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
    },
    "organisationProfile": {
      "activityTotal": 2625,
      "activityTotalPercent": 2625,
      "campaignDisplayTotal": 2625,
      "createdAt": "2020-12-03T06:52:46.330Z",
      "currency": "AUD",
      "description": "I believe in a better world",
      "donationCount": 12345,
      "donationRecordCount": 12345,
      "exerciseGoal": 12345,
      "exerciseGoalTime": 12345,
      "exerciseTotal": 2625,
      "exerciseTotalTime": 2625,
      "fundraiserTheme": "birthday",
      "goal": 100050,
      "individualProfileCount": 12345,
      "isCampaignProfile": true,
      "name": "Bob D.",
      "nonSelfDonationTotal": 2625,
      "organisationProfileCount": 12345,
      "paid": true,
      "path": "bobd",
      "photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
      "private": {
        "fieldA": "one",
        "fieldB": "yes"
      },
      "public": {
        "fieldA": "one",
        "fieldB": "yes"
      },
      "selfDonationTotal": 2625,
      "shared": true,
      "status": "ACTIVE",
      "subscriptionCount": 12345,
      "teamProfileCount": 12345,
      "type": "INDIVIDUAL",
      "uniqueDonors": 12345,
      "updatedAt": "2020-12-03T06:52:46.330Z",
      "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
    }
  }
}