v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Profiles

all members

Returns list of all members of a team profile

For custom components:

RaiselyComponents.api.one('profiles', '{path}').all('members').get(params = {}, headers = {}) => Promise<{result}>

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

get/profiles/{path}/members

Path parameters

pathstring required

The uuid or path of the record

Query parameters

campaignstring

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

privateboolean

Returns the full record when authenticated

qstring

Search query to find records matching

limitnumber

The number of records to limit per page

offsetnumber

The pagination offset (in number of records)

sortstring

The record attribute to filter on (use in conjunction with order)

order'asc' | 'desc'

The direction to sort (only applied if sort is also provided) * asc - Ascending * desc - Descending

Headers

Authorizationstring

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

Response

The resulting collection of Profile records. For performance reasons, as the parent profile must already be known to make this request, the following attributes of the parent object are omitted in the response: activityTotal, activityTotalPercent, campaignTotal, donationCount, exerciseTotal, exerciseTotalTime, feeTotal, grandTotal, total, totalPercent, uniqueDonors.

Example response

{
  "data": [
    {
      "activityTotal": 2625,
      "activityTotalPercent": 2625,
      "campaignDisplayTotal": 2625,
      "campaignTotal": 2625,
      "campaignUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "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,
      "grandTotal": 2625,
      "individualProfileCount": 12345,
      "isCampaignProfile": true,
      "name": "Bob D.",
      "nonSelfDonationTotal": 2625,
      "organisationProfileCount": 12345,
      "paid": true,
      "parent": {
        "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",
        "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"
        }
      },
      "parentUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "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,
      "total": 2625,
      "type": "INDIVIDUAL",
      "uniqueDonors": 12345,
      "updatedAt": "2020-12-03T06:52:46.330Z",
      "user": {
        "accessToken": "aaabbbccc",
        "address1": "31 Sunset Boulevard",
        "address2": "Unit 31b",
        "adminSettings": {
          "v4BetaOptin": true,
          "starredCampaigns": [
            "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
            "ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj"
          ]
        },
        "country": "AU",
        "createdAt": "2020-12-03T06:52:46.330Z",
        "email": "harveymilk@example.com",
        "facebookId": "fb_someurl",
        "firstName": "Leila",
        "fullName": "Leila Norma de Lima",
        "internal": {},
        "isAdmin": true,
        "isSamlLogin": true,
        "lastName": "de Lima",
        "permission": "PARTICIPANT",
        "phoneNumber": "+1 123-456-7890",
        "photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
        "postcode": "AAA BBBB",
        "preferredName": "Norma",
        "private": {
          "fieldA": "one",
          "fieldB": "yes"
        },
        "public": {
          "fieldA": "one",
          "fieldB": "yes"
        },
        "state": "Victoria",
        "status": "ACTIVE",
        "suburb": "Melbourne",
        "unsubscribedAt": "2020-12-03T06:52:46.330Z",
        "updatedAt": "2020-12-03T06:52:46.330Z",
        "username": "harveymilk@example.com",
        "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      },
      "userUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "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"
      }
    }
  ],
  "pagination": {
    "total": 10,
    "pages": 2,
    "offset": 5,
    "limit": 5
  }
}