> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # QueryDonationCampaigns # Package: donations # Namespace: DonationCampaignService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/donations/donation-campaigns/query-donation-campaigns.md ## Permission Scopes: Manage Donation Campaigns: SCOPE.DONATIONS.MANAGE-CAMPAIGNS ## Introduction Retrieves a list of donation campaigns, given the provided paging, filtering, and sorting. Query Donation Campaigns runs with these defaults, which you can override: - `createdDate` is sorted in `ASC` order - `cursorPaging.limit` is `100` To learn how to query donation campaigns, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). --- ## REST API ### Schema ``` Method: queryDonationCampaigns Description: Retrieves a list of donation campaigns, given the provided paging, filtering, and sorting. Query Donation Campaigns runs with these defaults, which you can override: - `createdDate` is sorted in `ASC` order - `cursorPaging.limit` is `100` To learn how to query donation campaigns, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). URL: https://www.wixapis.com/donation-campaigns/v2/donation-campaigns/query Method: POST Method parameters: param name: query | type: CursorQuery - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-filter-section). - name: sort | type: array | description: Sort object. Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-sort-section). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: QueryDonationCampaignsResponse - name: donationCampaigns | type: array | description: List of donation campaigns matching the query. - name: id | type: string | description: Donation campaign GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the donation campaign is updated. To prevent conflicting changes, the current `revision` must be specified when updating the donation campaign. Ignored when creating a donation campaign. - name: createdDate | type: string | description: Date and time the donation campaign was created. - name: updatedDate | type: string | description: Date and time the donation campaign was last updated. - name: name | type: string | description: Name of the donation campaign. - name: archived | type: boolean | description: Whether the donation campaign is archived and hidden from site visitors. Archived campaigns can't accept donations. Default: `false` - name: status | type: Status | description: Current status of the donation campaign. The status is automatically calculated based on campaign settings and current progress: - `COLLECTING`: Campaign is active and accepting donations - `EXPIRED`: Campaign has passed its end date and `acceptDonationsAfterEndDate` is `false` - `GOAL_REACHED`: Campaign has reached its target amount and `acceptDonationsAfterGoal` is `false` - enum: - COLLECTING: Campaign is actively accepting donations. - EXPIRED: Campaign has passed its `endDate` and `acceptDonationsAfterEndDate` is `false`. - GOAL_REACHED: Campaign has reached its `targetAmount` and `acceptDonationsAfterGoal` is `false`. - name: coverImage | type: Image | description: Cover image for the donation campaign. - name: id | type: string | description: WixMedia image GUID. - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image height. - name: width | type: integer | description: Original image width. - name: altText | type: string | description: Image alt text. - name: filename | type: string | description: Image filename. - name: customAmountEnabled | type: boolean | description: Whether donors can specify their own donation amount. If custom amounts are disabled, at least one predefined amount must be provided. Default: `false` - name: customAmountOptions | type: CustomAmountOptions | description: Optional settings for custom donation amounts. - name: minimum | type: MultiCurrencyPrice | description: Minimum donation amount. - name: amount | type: string | description: Amount. - name: convertedAmount | type: string | description: Converted amount. - name: formattedAmount | type: string | description: Amount formatted with currency symbol. - name: formattedConvertedAmount | type: string | description: Converted amount formatted with currency symbol. - name: maximum | type: MultiCurrencyPrice | description: Maximum donation amount. - name: predefinedDonationAmounts | type: array | description: Predefined donation amounts. Each amount can include an optional description explaining its impact. For example, "Feed 5 families for a week". - name: id | type: string | description: Predefined amount GUID. You must provide this GUID when creating or updating campaigns. - name: price | type: MultiCurrencyPrice | description: Donation amount. Currently supports the site's default currency only. - name: description | type: string | description: Description explaining the impact of this donation amount. For example, "Feed 5 families for a week" or "Plant 10 trees". - name: campaignGoal | type: CampaignGoal | description: Campaign fundraising goal. - name: targetAmount | type: MultiCurrencyPrice | description: Target fundraising amount. Currently supports the site's default currency only. - name: endDate | type: string | description: Campaign end date in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. The behavior after this date is controlled by `acceptDonationsAfterEndDate`. - name: acceptDonationsAfterEndDate | type: boolean | description: Whether donations are accepted after `endDate`. This field is ignored if `endDate` is not set. Default: `false` - name: acceptDonationsAfterGoal | type: boolean | description: Whether donations are accepted after reaching `targetAmount`. Default: `true` - name: commentsEnabled | type: boolean | description: Whether donors can add comments to their donations. Default: `false` - name: donationFrequencies | type: array | description: Donation frequencies available for this campaign. At least one frequency must be specified. - enum: - ONE_TIME: One-time donation. - WEEK: Weekly recurring donation. - MONTH: Monthly recurring donation. - YEAR: Yearly recurring donation. - name: askDonorCoverFee | type: boolean | description: Whether to ask donors during checkout if they want to add 2.9% to their donation to cover fees. When `false`, fees are deducted from the donation amount, meaning the campaign receives less than the donor's original contribution. When `true`, donors are presented with an option in the checkout UI to add a 2.9% fee on top of their donation. This fee helps offset processing costs, ensuring more of the original donation reaches the campaign. The donor always has the choice — they are never automatically charged the fee. For recurring donations, if the donor opts to cover fees, the 2.9% fee is applied to each recurring payment (not just the first one). > **Notes:** > + The 2.9% rate is fixed and cannot be customized by campaign owners. > + This feature works with all payment methods and currencies. Default: `false` - name: extendedFields | type: ExtendedFields | description: Custom field data for the program definition object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags assigned to this donation campaign. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, typically restricted from site members and visitors. - name: tagIds | type: array | description: List of tag GUIDs. - name: publicTags | type: TagList | description: Tags that are exposed to anyone with access to the entity, including site members and visitors. - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata for handling large result sets. - name: count | type: integer | description: Number of items returned in current page. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. Possible Errors: HTTP Code: 500 | Status Code: INTERNAL | Application Code: SITE_CURRENCY_UNAVAILABLE | Description: Site currency settings are temporarily unavailable. Try again later. ``` ### Examples ### // @Query Donation Campaigns @description: Queries for unarchived donation campaigns, sorted by creation date in descending order import { donationCampaigns } from "@wix/donations"; ```curl async function queryDonationCampaigns() { const response = await donationCampaigns .queryDonationCampaigns() .eq("archived", false) .descending("_createdDate") .limit(10) .find(); return response; } ``` ### Query Donation Campaigns Queries for unarchived donation campaigns, sorted by creation date in descending order ```curl curl -X POST \ 'https://www.wixapis.com/donation-campaigns/v2/donation-campaigns/query' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "query": { "filter": { "archived": false }, "sort": [ { "fieldName": "createdDate", "order": "DESC" } ], "paging": { "limit": 10, "offset": 0 } } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.donations.DonationCampaignService.queryDonationCampaigns(query) Description: Retrieves a list of donation campaigns, given the provided paging, filtering, and sorting. Query Donation Campaigns runs with these defaults, which you can override: - `createdDate` is sorted in `ASC` order - `cursorPaging.limit` is `100` To learn how to query donation campaigns, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: query Method parameters: param name: query | type: DonationCampaignQuery | required: true - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-filter-section). - name: sort | type: array | description: Sort object. Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-sort-section). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: PROMISE - name: donationCampaigns | type: array | description: List of donation campaigns matching the query. - name: _id | type: string | description: Donation campaign GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the donation campaign is updated. To prevent conflicting changes, the current `revision` must be specified when updating the donation campaign. Ignored when creating a donation campaign. - name: _createdDate | type: Date | description: Date and time the donation campaign was created. - name: _updatedDate | type: Date | description: Date and time the donation campaign was last updated. - name: name | type: string | description: Name of the donation campaign. - name: archived | type: boolean | description: Whether the donation campaign is archived and hidden from site visitors. Archived campaigns can't accept donations. Default: `false` - name: status | type: Status | description: Current status of the donation campaign. The status is automatically calculated based on campaign settings and current progress: - `COLLECTING`: Campaign is active and accepting donations - `EXPIRED`: Campaign has passed its end date and `acceptDonationsAfterEndDate` is `false` - `GOAL_REACHED`: Campaign has reached its target amount and `acceptDonationsAfterGoal` is `false` - enum: - COLLECTING: Campaign is actively accepting donations. - EXPIRED: Campaign has passed its `endDate` and `acceptDonationsAfterEndDate` is `false`. - GOAL_REACHED: Campaign has reached its `targetAmount` and `acceptDonationsAfterGoal` is `false`. - name: coverImage | type: string | description: Cover image for the donation campaign. - name: customAmountEnabled | type: boolean | description: Whether donors can specify their own donation amount. If custom amounts are disabled, at least one predefined amount must be provided. Default: `false` - name: customAmountOptions | type: CustomAmountOptions | description: Optional settings for custom donation amounts. - name: minimum | type: MultiCurrencyPrice | description: Minimum donation amount. - name: amount | type: string | description: Amount. - name: convertedAmount | type: string | description: Converted amount. - name: formattedAmount | type: string | description: Amount formatted with currency symbol. - name: formattedConvertedAmount | type: string | description: Converted amount formatted with currency symbol. - name: maximum | type: MultiCurrencyPrice | description: Maximum donation amount. - name: predefinedDonationAmounts | type: array | description: Predefined donation amounts. Each amount can include an optional description explaining its impact. For example, "Feed 5 families for a week". - name: _id | type: string | description: Predefined amount GUID. You must provide this GUID when creating or updating campaigns. - name: price | type: MultiCurrencyPrice | description: Donation amount. Currently supports the site's default currency only. - name: description | type: string | description: Description explaining the impact of this donation amount. For example, "Feed 5 families for a week" or "Plant 10 trees". - name: campaignGoal | type: CampaignGoal | description: Campaign fundraising goal. - name: targetAmount | type: MultiCurrencyPrice | description: Target fundraising amount. Currently supports the site's default currency only. - name: endDate | type: Date | description: Campaign end date in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. The behavior after this date is controlled by `acceptDonationsAfterEndDate`. - name: acceptDonationsAfterEndDate | type: boolean | description: Whether donations are accepted after `endDate`. This field is ignored if `endDate` is not set. Default: `false` - name: acceptDonationsAfterGoal | type: boolean | description: Whether donations are accepted after reaching `targetAmount`. Default: `true` - name: commentsEnabled | type: boolean | description: Whether donors can add comments to their donations. Default: `false` - name: donationFrequencies | type: array | description: Donation frequencies available for this campaign. At least one frequency must be specified. - enum: - ONE_TIME: One-time donation. - WEEK: Weekly recurring donation. - MONTH: Monthly recurring donation. - YEAR: Yearly recurring donation. - name: askDonorCoverFee | type: boolean | description: Whether to ask donors during checkout if they want to add 2.9% to their donation to cover fees. When `false`, fees are deducted from the donation amount, meaning the campaign receives less than the donor's original contribution. When `true`, donors are presented with an option in the checkout UI to add a 2.9% fee on top of their donation. This fee helps offset processing costs, ensuring more of the original donation reaches the campaign. The donor always has the choice — they are never automatically charged the fee. For recurring donations, if the donor opts to cover fees, the 2.9% fee is applied to each recurring payment (not just the first one). > **Notes:** > + The 2.9% rate is fixed and cannot be customized by campaign owners. > + This feature works with all payment methods and currencies. Default: `false` - name: extendedFields | type: ExtendedFields | description: Custom field data for the program definition object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags assigned to this donation campaign. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, typically restricted from site members and visitors. - name: tagIds | type: array | description: List of tag GUIDs. - name: publicTags | type: TagList | description: Tags that are exposed to anyone with access to the entity, including site members and visitors. - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata for handling large result sets. - name: count | type: integer | description: Number of items returned in current page. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. Possible Errors: HTTP Code: 500 | Status Code: INTERNAL | Application Code: SITE_CURRENCY_UNAVAILABLE | Description: Site currency settings are temporarily unavailable. Try again later. ``` ### Examples ### queryDonationCampaigns ```javascript import { donationCampaigns } from '@wix/donations'; async function queryDonationCampaigns(query) { const response = await donationCampaigns.queryDonationCampaigns(query); }; ``` ### queryDonationCampaigns (with elevated permissions) ```javascript import { donationCampaigns } from '@wix/donations'; import { auth } from '@wix/essentials'; async function myQueryDonationCampaignsMethod(query) { const elevatedQueryDonationCampaigns = auth.elevate(donationCampaigns.queryDonationCampaigns); const response = await elevatedQueryDonationCampaigns(query); } ``` ### queryDonationCampaigns (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { donationCampaigns } from '@wix/donations'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { donationCampaigns }, // Include the auth strategy and host as relevant }); async function queryDonationCampaigns(query) { const response = await myWixClient.donationCampaigns.queryDonationCampaigns(query); }; ``` ---