--- title: "all donations" method: GET path: "/profiles/{path}/donations" tags: ["Profiles"] --- # all donations `GET /profiles/{path}/donations` Returns a list of donations you've previously created. The donations will be returned in descending order of when they were created, unless you specify otherwise. #### For custom components: `RaiselyComponents.api.one('profiles', '{path}').get('donations', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper ## Path parameters - `path` string, required ## Query parameters - `private` boolean - `q` string - `limit` number - `offset` number - `sort` string - `order` 'asc' | 'desc' - `type` string - `currency` string - `isSuspicious` boolean - `status` string - `mode` string - `designation` string - `user` string - `campaign` string - `organisation` string - `profile` string - `subscription` string - `matchedDonationConfig` string ## Headers - `Authorization` string ## Response `200` The resulting collection of Donation records - object - `data` MemberDonation[] - `address1` string — `public` Line 1 of an address - `address2` string — `public` Line 2 of an address - `amount` integer, required — `public` The total amount of the donation being made - `amountRefunded` integer — `public` Total amount refunded to the donor - `anonymous` boolean — `public` Does the donor wish to be anonymous - `campaignAmount` integer — `public` Transaction amount in the currency of the campaign - `campaignDisplayTotal` integer — `public` The total contribution in cents of this donation to the campaign total, in the campaign currency - `campaignFee` integer — `public` Fee paid to Raisely in the currency of the campaign - `campaignRaisely` integer — `public` Raisely fee in the currency of the campaign - `campaignUuid` string — `public` Unique identifier for the record - `card` string — `public` ID of the payment method used (from the payment gateway) - `cardPreview` integer — `public` Last 4 digits of the card - `charge` string — `public` ID for the charge (from the payment gateway) - `context` object — `public` Context data (UTM parameters) from the "created" interaction - `country` string — `public` - `createdAt` string — `public` Date the record was created - `currency` string, required — `public` 3 letter currency code - `currencySymbol` string — `public` The symbol of the currency - `customer` string — `public` The customer ID (assigned by the payment gateway) - `date` string — `public` The date and time (in ISO8601 format) the donation was received by the organisation (only for OFFLINE donations) - `declineCode` string — `public` The decline code from Stripe associated with this donation, if applicable - `designation` NestedDesignation - `createdAt` string — `public` Date the record was created - `externalId` string — `public` - `name` string, required — `public` Internal name for a designation. - `organisationId` integer — `public` - `publicName` string, required — `public` Public name to be displayed on campaign for a designation. - `status` 'ACTIVE' | 'ARCHIVED', required — `public` - `updatedAt` string — `public` Date the record was last updated - `uuid` string — `public` Unique identifier for the record - `designationUuid` string — `public` UUID of the designation assigned to this donation - `displayTotal` integer — `public` The total contribution in cents of this donation to the campaign total, in the donation currency - `donationTotal` integer — `public` The total donation amount - `email` string, required — `public` Email address of the donor - `fee` integer — `public` The fee paid to Raisely - `feeOptIn` boolean — `public` True if the donor chose to pay the Raisely fee - `firstName` string — `public` The first name of the person - `forRegistration` string — `public` Not null values indicate this transaction has been set aside to pay for an upcoming registration - `fullName` string — `public` The full name of the person - `gatewayVersion` string — `public` Gateway Version of donation method, if any - `giftAidText` string — `public` The Gift Aid text that the donor saw and agreed to - `gst` integer — `public` GST on the Raisely fee (always in AUD) - `id` integer — `public` Simple ID for the donation - `includesGiftAid` boolean — `public` Gift aid donation included - `ipNumber` string — `public` IP Address of the donor - `isExpress` boolean — `public` Indicates whether this donation was made via an express payment flow - `isFraud` boolean — `public` True if a transaction was rejected as fraudulent by the gateway - `isSuspicious` boolean — `public` True if a transaction was blocked for suspected (or actual) fraudulent activity - `items` object[] — `public` The donation items associated with this donation - `amount` integer — `public` The amount spent on the item in the currency of the donation - `amountRefunded` integer — `public` The total amount refunded in cents for this line item, in the donation currency. - `attendance` 'CHECKED_IN' | 'VALID' — `public` Whether the donation item (ticket) has been checked in - `campaignAmount` integer — `public` The amount spent on the item in the currency of the campaign - `createdAt` string — `public` ISO8601 created timestamp - `description` string — `public` Description of the item - `includeInTotals` boolean — `public` If false, the amount is not included in receipts as part of the total donation - `itemId` string — `public` The item ID / reference - `originalAmount` integer — `public` The total amount of this line item in cents prior to any refunds, in the donation currency. Amount is tax inclusive. - `parentBundleItem` string — `public` The item ID / reference of this ticket's parent bundle - `parentBundleItemDescription` string — `public` The ticket's parent bundle description - `perkUuid` string — `public` Deprecated - `private` object — `public` - `productUuid` string — `public` The uuid for the associated product or ticket. - `public` object — `public` - `quantity` integer — `public` If multiple of the item, the number of items claimed - `status` 'ISSUED' | 'CANCELLED' — `public` The status of the donation item - `type` 'DONATION' | 'REGISTRATION' | 'OTHER' | 'TICKET' | 'DISCOUNT' — `public` The item type. For most manual API calls, you should use the value `OTHER`. - `updatedAt` string — `public` ISO8601 created timestamp - `uuid` string — `public` Unique identifier for the item - `itemTypes` string[] — `public` One or more of DONATION, REGISTRATION, TICKET or OTHER - `lastName` string — `public` The last name of the person - `message` string — `public` Message from the donor - `method` 'CREDIT_CARD' | 'PAYPAL' | 'APPLE_PAY' | 'OFFLINE' | 'CUSTOM' | 'STRIPE_INTENT' | 'FACEBOOK', required — `public` The payment gateway used - `methodType` string — `public` The type of payment method used, to distinguish between card, direct debit and digital wallet payments. - `mode` 'LIVE' | 'TEST' — `public` LIVE or TEST - `orderTotal` integer — `public` The total order amount - `orderUuid` string — `public` Unique identifier for the record - `phoneNumber` string — `public` Phone number of the donor - `postcode` string — `public` Postal code of the donor - `preferredName` string — `public` The name that the person prefers to be called - `private` object — `public` Private values for this record - `processing` 'ONCE' | 'RECURRING' — `public` If this is a one time or recurring donation - `profile` NestedProfile - `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) - `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) - `donationRecordCount` integer — `public` Every donation record on this profile regardless of status or mode (same scope as permanent-delete validation, broader than donationCount). - `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) - `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 - `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 - `pronouns` string — `public` Pronouns of the profile - `public` object — `public` Public values for this record - `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` 'ACTIVE' | 'DELETED' | 'PURGED' — `public` ACTIVE, DELETED, or PURGED - `subscriptionCount` integer — `public` Subscriptions associated with this profile (same scope as permanent-delete validation). - `teamProfileCount` integer — `public` Number of team profiles that have joined this profile (or it's descendants) - `type` 'INDIVIDUAL' | 'GROUP' | 'ORGANISATION' — `public` INDIVIDUAL, GROUP or ORGANISATION - `uniqueDonors` integer — `public` Total unique donors to the profile - `updatedAt` string — `public` Date the record was last updated - `uuid` string — `public` Unique identifier for the record - `profileUuid` string — `public` Unique identifier for the record - `providerRaisely` integer — `public` Raisely fee in the currency of the provider - `public` object — `public` Public values for this record - `publicAmount` integer — `public` Raisely fee in the currency of the provider (as dollars) - `publicFee` integer — `public` Raisely fee in the currency of the provider (as dollars) - `publicTotal` integer — `public` Raisely fee in the currency of the provider (as dollars) - `result` object — `public` Object containing the result of the (attempted) transaction from the payment gateway - `state` string — `public` - `status` 'OK' | 'FAILED' | 'PENDING' | 'REFUNDED' | 'DELETED' — `public` Status of the payment - `suburb` string — `public` - `swiftAidStatus` 'OK' | 'FAILED' | 'PENDING' | 'DELETING' | 'DELETED' — `public` Status of donation on SwiftAid - `taxRate` number — `public` The tax percentage used to calculate the tax total - `taxTotal` integer — `public` The total tax charged in cents within items on this donation, in the donation currency - `taxType` string — `public` The type of tax (inclusive or exclusive) - `token` string — `public` The payment token from the gateway - `total` integer — `public` The total transaction amount paid by donor - `type` 'ONLINE' | 'OFFLINE', required — `public` ONLINE or OFFLINE - `updatedAt` string — `public` Date the record was last updated - `usedSwiftAid` boolean — `public` Swiftaid used to process Gift Aid - `user` NestedUser - `accessToken` string — `public` A secret token for this user, used to authenticate them against the API or in your campaign. - `address1` string — `public` Line 1 of an address - `address2` string — `public` Line 2 of an address - `adminSettings` object — `public` Object containing settings for admin users - `v4BetaOptin` boolean — `public` Whether admin has opted into v4 - `starredCampaigns` string[] — `public` Array of favourite campaigns for user - `country` string — `public` The country of the user - `createdAt` string — `public` Date the record was created - `email` string — `public` The user's email address. Raisely uses this as a unique identifier and will deduplicate on email. - `facebookId` string — `public` The Facebook ID provided on authentication - `firstName` string — `public` The first name of the user - `fullName` string — `public` The full name of the user - `internal` object — `public` Internal values related to this record - `ipCity` string — `public` Deprecated - `ipCountry` string — `public` Deprecated - `ipLatitude` number — `public` Deprecated - `ipLongitude` number — `public` Deprecated - `ipNumber` string — `public` Deprecated - `isAdmin` boolean — `public` Will be true if this user has admin permissions - `isSamlLogin` boolean — `public` Will be true if this user logs in via organisation SAML login - `language` string — `public` The language the user last interacted in - `lastName` string — `public` The last name of the user - `permission` string — `public` Deprecated. Use roles - `phoneNumber` string — `public` Phone number of the user - `photoUrl` string — `public` URL of the user's photo - `postcode` string — `public` Postal code of the user - `preferredName` string — `public` The name that the user prefers to be called - `private` object — `public` Private values for this record - `public` object — `public` Public values for this record - `state` string — `public` The state/province of the user - `status` 'ACTIVE' | 'DELETED' | 'PENDING' — `public` ACTIVE, DELETED, or PENDING - `suburb` string — `public` The suburb/city of the user - `swiftAidAuthExpiry` string — `public` Date of expiry of donor authorisation for SwiftAid - `swiftAidDonorId` string — `public` Id of donor on SwiftAid - `unsubscribedAt` string — `public` ISO8601 timestamp of when the user was unsubscribed from non-essential emails or sms. A blank value indicates the user is still subscribed. - `updatedAt` string — `public` Date the record was last updated - `username` string — `public` The login email for this user - `uuid` string — `public` Unique identifier for the record - `userId` integer — `public` The id of the Raisely user associated with this donation - `userUuid` string — `public` Unique identifier for the record - `uuid` string — `public` Unique identifier for the record - `pagination` Pagination - `total` integer — The total amount of records returned - `pages` integer — The amount of pages (by limit) returned - `prevUrl` union — Url that points to the previous set of records in the pagination if available - string - boolean - `nextUrl` union — Url that points to the next set of records in the pagination if available - string - boolean - `offset` integer — The total number of records to offset in the pagination - `limit` integer — The maximum amount of records to shown in each page ## Other responses - `401` — Authorization credentials were missing or invalid - `403` — The user is authenticated, but is not allowed to perform the requested operation - `404` — One of the records needed to complete the request could not be found - `410` — The requested record no longer exists, or that API has been deprecated - `429` — You have made too many requests to the given endpoint, please try again later - `500` — An unexpected error has occurred with Raisely. If the error persists you can contact support@raisely.com --- [API](https://skmtc.net/raisely/apis/raisely-api.md) · [All operations](https://skmtc.net/raisely/apis/raisely-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/raisely/raisely-api/versions/d7f8dd294cb0/schema)