get all

get https://api.raisely.com/v3/profiles

Returns all fundraising profiles in a campaign

For custom components:

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

See Restie Response Data for a more detailed overview of responses through the client wrapper

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

data

array of objects

data

object

activityTotal

integer

public The total contribution of this profile towards its activity goal

activityTotalPercent

integer

public The percentage of the total activity measure compared to the profile goal (out of 100)

campaignDisplayTotal

integer

public The total amount raised by a profile (in the currency of the campaign)

campaignTotal

integer

public The total amount contributed by a profile to the campaign total (in the currency of the campaign)

campaignUuid

string

public Unique identifier for the record

createdAt

string

public Date the record was created

currency

string

public 3 letter currency code

description

string

public Public description of the fundraiser profile

donationCount

integer

public Total donations made to this profile and it's children. (excluded matched gifts)

exerciseGoal

integer

public The exercise distance goal for the profile, in metres

exerciseGoalTime

integer

public The time spent exercising goal for the profile, in minutes

exerciseTotal

integer

public The total distance of exercise completed, in metres

exerciseTotalTime

integer

public The total amount of time exercising, in minutes

facebookFundraiserId

string

public Facebook Fundraiser ID linked to the profile

fundraiserTheme

string

public Path of the DIY fundraiser theme selected by the fundraiser

goal

integer

public Fundraising target (in cents)

grandTotal

integer

public The total amount raised by a profile (including registration fees)

individualProfileCount

integer

public Number of individual profiles that have joined this profile (or it's descendants)

isCampaignProfile

boolean

public Shows true if this profile is the campaign profile

name

string

public The name of the profile

nonSelfDonationTotal

integer

public The total amount raised by a profile excluding self-donations (in the currency of the campaign)

organisationProfileCount

integer

public Number of team profiles that have joined this profile (or it's descendants)

paid

boolean

public Flagged as true if this profile was used as part of a paid registration

parent

object

public

parentUuid

string

public Unique identifier for the record

path

string

public The path of this record (for alternative lookup)

photoUrl

string

public URL of the profile photo

private

object

public Private values for this record

Has additional fields

pronouns

string

public Pronouns of the profile

public

object

public Public values for this record

Has additional fields

selfDonationTotal

integer

public The total amount raised by self-donations for an individual profile (in the currency of the campaign)

shared

boolean

public Flag that determines if a profile has been shared by its owner

status

string

public ACTIVE or DELETED

ACTIVE DELETED

tags

object

color

string

public The color used to display this tag within the admin interface

createdAt

string

public Date the record was created

internal

object

public Internal values related to this record

Has additional fields

isPrivate

boolean

public Indicates if this tag is publicly available

label

string

public The text used to identity this tag within the admin interface

organisationUuid

string

public Unique identifier for the record

path

string

public The path of this record (for alternative lookup)

recordType

string

public The type of record represented by this tag

updatedAt

string

public Date the record was last updated

uuid

string

public Unique identifier for the record

teamProfileCount

integer

public Number of team profiles that have joined this profile (or it's descendants)

total

integer

public The total amount raised by a profile (in the currency of the profile)

type

string

public INDIVIDUAL, GROUP or ORGANISATION

INDIVIDUAL GROUP ORGANISATION

uniqueDonors

integer

public Total unique donors to the profile

updatedAt

string

public Date the record was last updated

user

object

public

userUuid

string

public Unique identifier for the record

uuid

string

public Unique identifier for the record

teamProfile

object

public The fundraising team this profile belongs to

organisationProfile

object

public The fundraising organisation this profile belongs to

pagination

object

total

integer

The total amount of records returned

pages

integer

The amount of pages (by limit) returned

prevUrl

Url that points to the previous set of records in the pagination if available

nextUrl

Url that points to the next set of records in the pagination if available

offset

integer

The total number of records to offset in the pagination

limit

integer

The maximum amount of records to shown in each page

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.raisely.com/v3/profiles \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of profiles

401Authorization credentials were missing or invalid

403The user is authenticated, but is not allowed to perform the requested operation

410The requested record no longer exists, or that API has been deprecated

429You have made too many requests to the given endpoint, please try again later

500An unexpected error has occurred with Raisely. If the error persists you can contact support@raisely.com