Skip to content

Integration · Payments

grassrootz.com

Connect Claude & ChatGPT to Grassrootz

Ask your AI how a campaign is doing, who donated this week, or to look up a supporter's ticket in Grassrootz. It can search and read campaigns, events, teams, fundraiser pages, donors, fundraisers, donations, recurring donations, sales, buyers and tickets. It can also update campaigns and donations, and refund online donations and sales.

Connect Grassrootz free

Free plan, no credit card. Takes about a minute.

Try asking

  • “How much has the Spring Run campaign raised so far?”

    The AI searches campaigns by name and reads the campaign with its targets and totals.

  • “Find all donations from [email protected].”

    It searches donations by email and shows amount, donor, message and payment details.

  • “How close is Tom's fundraiser page to its target?”

    It searches fundraiser pages by name and reads the target and the amount raised.

What your AI can do

Campaigns and events

Search and read campaigns, events, teams and fundraiser pages with targets and totals, and update campaign settings.

Donations and supporters

Search donations, recurring donations, donors and fundraisers, and change a donation's display name or message.

Sales and tickets

Search ticket and merchandise sales, buyers and tickets, and refund online sales in full or in part.

  • “Does Peter Olsen have a ticket for the gala dinner?”

    It searches tickets by attendee name and shows the matching tickets.

  • “Change the display name on donation 5821 to Anonymous.”

    It updates the donation's display name. Only that field changes.

  • “Refund donation 5821 in full.”

    It refunds the online donation. The money goes back to the donor, and the refund cannot be undone.

496 tools for Grassrootz

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

  • create_access_keyChanges dataCreate a new access key. Search access keys first to avoid duplicates. API summary: Creates a new access key.
  • create_accountChanges dataCreate a new account for a account. Search accounts first to avoid duplicates. API summary: Creates a new account integration.
  • create_account_achievementChanges dataCreate a new achievement for a account. API summary: Creates a new fundraiser achievement.
  • create_account_backofficeChanges dataCreate a new backoffice for a account. API summary: Processes a backoffice request for an object.
  • create_account_decisionChanges dataCreate a new decision for a account. API summary: Records a reviewer decision (Approve or Block) and runs the side-effects.
  • create_account_demoteChanges dataCreate a new demote for a account. API summary: Demotes an account.
  • create_account_heartbeatChanges dataCreate a new heartbeat for a account. API summary: Refreshes the heartbeat on the caller's existing review lock.
  • create_account_leadChanges dataCreate a new lead for a account. Required: product. Search leads first to avoid duplicates. API summary: Invite friends via email address and a message to encourage them to join the campaign (via ticketing).
  • create_account_rescoreChanges dataCreate a new rescore for a account. API summary: Enqueues a fresh classification for an event's page subject.
  • create_account_v2_account_log_consent_events_postChanges dataCreate a new account for a account. Search accounts first to avoid duplicates. API summary: Records consent decisions the account holder made on their own screen.
  • create_account_v2_account_post_donation_report_postChanges dataCreate a new account. Search accounts first to avoid duplicates. API summary: Creates a new account report.
  • create_account_v2_account_post_email_opt_anonymous_postVisible to othersCreate a new account. Search accounts first to avoid duplicates. Has effects visible outside this system. API summary: Opt in or out from emails (microblog, fitness) anonymously.
  • create_account_v2_account_post_email_opt_postVisible to othersCreate a new account. Search accounts first to avoid duplicates. Has effects visible outside this system. API summary: Opt in or out from emails (donation, sale).
  • create_account_v2_account_post_integration_operation_postChanges dataCreate a new account. Search accounts first to avoid duplicates. API summary: Creates a new account integration.
  • create_account_v2_account_post_multifactor_postChanges dataCreate a new account for a account. Search accounts first to avoid duplicates. API summary: Creates a new account multi factor entry.
  • create_account_v2_account_post_multifactor_reset_postChanges dataCreate a new account. Search accounts first to avoid duplicates. API summary: Resets an account multi factor configuration on behalf of the account holder.
  • create_account_v2_account_post_password_reset_request_postDeletesCreate a new account. Search accounts first to avoid duplicates. Destructive action; may require approval. API summary: Starts a password reset process.
  • create_account_v2_account_post_password_update_postDeletesCreate a new account. Search accounts first to avoid duplicates. Destructive action; may require approval. API summary: Updates the password for a specific account based on an email and reset token.
  • create_account_v2_account_post_postChanges dataCreate a new account. Search accounts first to avoid duplicates. API summary: Creates a new account.
  • create_account_v2_account_post_promotion_postChanges dataCreate a new account for a account. Search accounts first to avoid duplicates. API summary: Promotes an account.
  • create_account_v2_campaign_post_bulk_fundraisers_postVisible to othersCreate a new account. Search accounts first to avoid duplicates. Has effects visible outside this system. API summary: Creates a new bulk campaign child pages request.
  • create_account_v2_event_post_postChanges dataCreate a new account. Search accounts first to avoid duplicates. API summary: Creates a new event.
  • create_account_v2_fundraiser_post_postChanges dataCreate a new account. Search accounts first to avoid duplicates. API summary: Creates a new fundraiser.
  • create_backofficeChanges dataCreate a new backoffice. API summary: Processes a backoffice request for an object.
  • create_backoffice_v2_event_post_backoffice_postChanges dataCreate a new backoffice. API summary: Processes a backoffice request for an object.
  • create_bulkVisible to othersCreate a new bulk. Has effects visible outside this system. API summary: Create 1 or more new terminals.
  • create_campaignChanges dataCreate a new campaign. Search campaigns first to avoid duplicates. API summary: Creates a new campaign.
  • create_campaign_backofficeChanges dataCreate a new backoffice for a campaign. API summary: Processes a backoffice request for an object.
  • create_campaign_organizerChanges dataCreate a new campaign organizer. Search campaign organizers first to avoid duplicates. API summary: Creates a new Campaign Organizer.
  • create_campaign_paymentChanges dataCreate a new payment for a campaign. Search payments first to avoid duplicates. API summary: Adds an additional payment platform to a campaign.
  • create_campaign_shipping_optionChanges dataCreate a new campaign shipping option. Search campaign shipping options first to avoid duplicates. API summary: Creates a new campaign shipping option.
  • create_campaign_terminalChanges dataCreate a new terminal for a campaign. Search terminals first to avoid duplicates. API summary: Creates a terminal configuration for a campaign.
  • create_categoryChanges dataCreate a new category. Search categories first to avoid duplicates. API summary: Creates a new collection.
  • create_category_achievementChanges dataCreate a new achievement for a category. API summary: Creates a new team achievement.
  • create_category_v2_collection_post_achievement_postChanges dataCreate a new category for a category. Search categories first to avoid duplicates. API summary: Creates a new team achievement.
  • create_category_v2_team_post_postChanges dataCreate a new category. Search categories first to avoid duplicates. API summary: Creates a new team.
  • create_companyChanges dataCreate a new company. Search companies first to avoid duplicates. API summary: Creates a new organization.
  • create_company_v2_organization_create_vero_integration_postChanges dataCreate a new company. Required: auth token. Search companies first to avoid duplicates. API summary: Creates a new Vero integration for an organization (auto-disables any existing active integration).
  • create_company_v2_organization_post_crm_platform_postChanges dataCreate a new company. Search companies first to avoid duplicates. API summary: Complete payment platform setup.
  • create_company_v2_organization_post_onboarding_postChanges dataCreate a new company. Search companies first to avoid duplicates. API summary: Creates a new organization.
  • create_company_v2_organization_post_organization_backoffice_postChanges dataCreate a new company for a company. Search companies first to avoid duplicates. API summary: Processes a backoffice request for an object.
  • create_company_v2_organization_post_payment_platform_postChanges dataCreate a new company. Search companies first to avoid duplicates. API summary: Complete payment platform setup.
  • create_company_v2_organization_resend_monthly_report_postVisible to othersCreate a new company for a company. Search companies first to avoid duplicates. Has effects visible outside this system. API summary: Resend monthly report.
  • create_company_v2_organization_webhook_subscriber_post_postDeletesCreate a new company. Search companies first to avoid duplicates. Destructive action; may require approval. API summary: Creates a new organization webhook subscriber.
  • create_convertChanges dataCreate a new convert.
  • create_decision_resetChanges dataCreate a new reset for a decision. API summary: Marks an active decision as Superseded so the event re-enters the queue.
  • create_documentChanges dataCreate a new document. API summary: Publishes a version of a consent document.
  • create_donationChanges dataCreate a new donation. Search donations first to avoid duplicates. API summary: Creates a new donation.
  • create_donation_feeChanges dataCreate a new donation fee. Search donation fees first to avoid duplicates. API summary: Creates a new donation fee.
  • create_donation_receiptChanges dataCreate a new receipt for a donation. API summary: Perform a refund on an online donation.
  • create_donation_replyChanges dataCreate a new reply for a donation. API summary: Creates a new donation message reply.
  • create_event_ambassadorChanges dataCreate a new event ambassador. Search event ambassadors first to avoid duplicates. API summary: Creates a new event ambassador.
  • create_event_ambassador_programChanges dataCreate a new event ambassador program. Search event ambassador programs first to avoid duplicates. API summary: Creates a new event.
  • create_event_ambassador_program_companyChanges dataCreate a new company for a event ambassador program. Search companies first to avoid duplicates. API summary: Manages a specific organization within an event ambassador program (creates/updates campaign ambassador program).
  • create_event_organizerChanges dataCreate a new event organizer. Search event organizers first to avoid duplicates. API summary: Creates a new Event organizer.
  • create_facebookChanges dataCreate a new facebook. API summary: Initiates a login procedure via a facebook.
  • create_fitness_platform_linkChanges dataCreate a new fitness platform link. Search fitness platform links first to avoid duplicates. API summary: Creates a new fitnessPlatformLink.
  • create_forceDeletesCreate a new force. Destructive action; may require approval. API summary: Demands a password rotation of an account, ending its sessions.
  • create_franchiseChanges dataCreate a new franchise. Search franchises first to avoid duplicates. API summary: Creates a Franchise and its editions.
  • create_fundraisingChanges dataCreate a new fundraising. API summary: Provides bearer token for fundraising accounts.
  • create_impersonateDeletesCreate a new impersonate. Destructive action; may require approval. API summary: Impersonates the given account using the current admin credential.
  • create_inactiveDeletesCreate a new inactive. Destructive action; may require approval. API summary: Impersonates the given account using the current admin credential.
  • create_leadChanges dataCreate a new lead. Required: campaign id, type, product or email. Search leads first to avoid duplicates. API summary: Creates a new lead.
  • create_merchandiseChanges dataCreate a new merchandise. Search merchandises first to avoid duplicates. API summary: Creates a new merchandise.
  • create_merchandise_productChanges dataCreate a new product for a merchandise. API summary: Creates a new merchandise sku.
  • create_microblogChanges dataCreate a new microblog. Search microblogs first to avoid duplicates. API summary: Creates a new microblog.
  • create_passwordlessDeletesCreate a new passwordless. Destructive action; may require approval. API summary: Initiates a login procedure via a email-magic-link request.
  • create_paymentChanges dataCreate a new payment. Search payments first to avoid duplicates. API summary: Perform a request for a new installment manual payment.
  • create_refundChanges dataCreate a new refund. Search refunds first to avoid duplicates. API summary: Creates a new sale.
  • create_refund_check_inChanges dataCreate a new check in for a refund. API summary: Check in all non-checked-in, non-returned details for a sale.
  • create_refund_invoiceChanges dataCreate a new invoice for a refund. API summary: Perform a refund on an online sale.
  • create_sale_couponChanges dataCreate a new sale coupon. Search sale coupons first to avoid duplicates. API summary: Creates a new SaleCoupon.
  • create_sale_coupon_instanceChanges dataCreate a new instance for a sale coupon. API summary: Creates a new SaleCoupon Instance.
  • create_sale_feeChanges dataCreate a new sale fee. Search sale fees first to avoid duplicates. API summary: Creates a new sale fee.
  • create_seriesChanges dataCreate a new series. Search series first to avoid duplicates. API summary: Creates a new series.
  • create_startChanges dataCreate a new start. API summary: Records that an admin started linking an organization to Swiftaid, and returns the Swiftaid charity portal to redirect them to.
  • create_subscriptionChanges dataCreate a new subscription. Search subscriptions first to avoid duplicates. API summary: Creates a new donation intent.
  • create_subscription_v2_donation_subscription_post_intent_postChanges dataCreate a new subscription. Search subscriptions first to avoid duplicates. API summary: Creates a new donationSubscription.
  • create_subscription_v2_donation_subscription_post_postChanges dataCreate a new subscription. Search subscriptions first to avoid duplicates. API summary: Creates a new donationSubscription.
  • create_subscription_v2_event_ambassador_post_intent_postChanges dataCreate a new subscription. Search subscriptions first to avoid duplicates.
  • create_taskChanges dataCreate a new task. Search tasks first to avoid duplicates. API summary: Creates a new fitnessActivity.
  • create_task_v2_fitness_activity_post_postChanges dataCreate a new task. Search tasks first to avoid duplicates. API summary: Creates a new fitnessActivity.
  • create_terminalChanges dataCreate a new terminal. Search terminals first to avoid duplicates. API summary: Creates a new donation.
  • create_terminal_configChanges dataCreate a new config for a terminal. API summary: Using terminal serial number create a campaign terminal configuration, which can be used by campaign/terminal/ apis.
  • create_terminal_connectChanges dataCreate a new connect for a terminal. API summary: Create a new terminal connection token.
  • create_terminal_v2_terminal_post_postChanges dataCreate a new terminal. Search terminals first to avoid duplicates. API summary: Creates a new Terminal.
  • create_ticketChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • create_ticket_v2_campaign_ambassador_program_post_search_public_Changes dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • create_ticket_v2_custom_activity_post_search_public_postChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • create_ticket_v2_donation_post_search_public_postChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • create_ticket_v2_donation_subscription_payment_post_public_searcChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • create_ticket_v2_fitness_activity_post_search_public_postChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • create_ticket_v2_leaderboard_by_amount_post_amount_search_publicChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • create_ticket_v2_leaderboard_by_custom_post_search_public_postChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • create_ticket_v2_leaderboard_by_fitness_post_search_public_postChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • create_ticket_v2_merchandise_post_search_public_postChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • create_ticket_v2_microblog_post_search_public_postChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • create_ticket_v2_page_post_event_campaign_grouping_search_publicChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Useful for grouping multiple event campaigns by charity via search.
  • create_ticket_v2_page_post_search_public_postChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • create_ticket_v2_ticket_post_postChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Creates a new ticket.
  • create_ticket_v2_ticket_post_search_public_postChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • create_ticket_v2_timeline_post_amount_search_public_postChanges dataCreate a new ticket. Search tickets first to avoid duplicates. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • delete_access_keyDeletesPermanently delete a access key by access key id. Destructive action; may require approval. API summary: Deletes a key object by id.
  • delete_accountDeletesPermanently delete a account by account id. Destructive action; may require approval. API summary: Deletes an account object by id.
  • delete_account_lockDeletesPermanently delete a account by event id. Destructive action; may require approval. API summary: Releases the caller's review lock.
  • delete_account_v2_account_delete_integration_deleteDeletesPermanently delete a account by account key. Destructive action; may require approval. API summary: Patches (partial update) an account object by id.
  • delete_account_v2_account_delete_integration_organizsation_deletDeletesPermanently delete a account by organization id. Destructive action; may require approval. API summary: Patches (partial update) an account object by id.
  • delete_account_v2_event_delete_deleteDeletesPermanently delete a account by account id. Destructive action; may require approval. API summary: Deletes a event object by id.
  • delete_account_v2_fundraiser_delete_deleteDeletesPermanently delete a account by account id. Destructive action; may require approval. API summary: Deletes a fundraiser object by id.
  • delete_accountsMoves moneyPermanently delete a account by account id. Financial or irreversible action; may require approval. API summary: Creates a new account multi factor entry.
  • delete_campaignDeletesPermanently delete a campaign by campaign id. Destructive action; may require approval. API summary: Deletes a campaign object by id.
  • delete_campaign_ambassador_programDeletesPermanently delete a campaign ambassador program by campaign ambassador program id. Destructive action; may require approval. API summary: Deletes a campaign ambassador program object object by id.
  • delete_campaign_organizerDeletesPermanently delete a campaign organizer by campaign organizer id. Destructive action; may require approval. API summary: Deletes a Campaign Organizer object by id.
  • delete_campaign_paymentDeletesPermanently delete a payment by payment id. Destructive action; may require approval. API summary: Removes an payment platform from a campaign.
  • delete_campaign_shipping_optionDeletesPermanently delete a campaign shipping option by campaign shipping option id. Destructive action; may require approval. API summary: Deletes a key object by id.
  • delete_categoryDeletesPermanently delete a category by category id. Destructive action; may require approval. API summary: Deletes a collection object by id.
  • delete_category_v2_team_delete_deleteDeletesPermanently delete a category by category id. Destructive action; may require approval. API summary: Deletes a team object by id.
  • delete_companyDeletesPermanently delete a company by company id. Destructive action; may require approval. API summary: Deletes an organization object by id.
  • delete_company_v2_organization_disable_vero_integration_deleteDeletesPermanently delete a company by integration id. Destructive action; may require approval. API summary: Disables (soft-deletes) a Vero integration for an organization.
  • delete_company_v2_organization_webhook_subscriber_delete_deleteDeletesPermanently delete a company by company id. Destructive action; may require approval. API summary: Deletes an organization webhook subscriber object by id.
  • delete_data_exportDeletesPermanently delete a data export by data export id. Destructive action; may require approval. API summary: Deletes a key object by id.
  • delete_documentDeletesPermanently delete a document by document id. Destructive action; may require approval. API summary: Withdraws a version that has not taken effect yet.
  • delete_donationDeletesPermanently delete a donation by donation id. Destructive action; may require approval. API summary: Deletes (offline only) a donation object by id.
  • delete_donation_feeDeletesPermanently delete a donation fee by donation fee id. Destructive action; may require approval. API summary: Deletes a donation fee object by id.
  • delete_donation_repliesMoves moneyPermanently delete a reply by donation id. Financial or irreversible action; may require approval. API summary: Delete a donation message reply.
  • delete_event_ambassadorDeletesPermanently delete a event ambassador by event ambassador id. Destructive action; may require approval. API summary: Deletes a event ambassador object by id.
  • delete_event_ambassador_programDeletesPermanently delete a event ambassador program by event ambassador program id. Destructive action; may require approval. API summary: Deletes a event ambassador program object by id.
  • delete_event_organizerDeletesPermanently delete a event organizer by event organizer id. Destructive action; may require approval. API summary: Deletes a Event organizer object by id.
  • delete_fitness_platform_linkDeletesPermanently delete a fitness platform link by fitness platform link id. Destructive action; may require approval. API summary: Patches (partial update) a fitnessPlatformLink object by id.
  • delete_franchiseDeletesPermanently delete a franchise by franchise id. Destructive action; may require approval. API summary: Deletes a Franchise (soft-delete).
  • delete_impersonatesMoves moneyPermanently delete a impersonate. Financial or irreversible action; may require approval. API summary: Terminates the impersonation using the current admin credential.
  • delete_leadDeletesPermanently delete a lead by lead id. Destructive action; may require approval. API summary: Deletes a lead object by id.
  • delete_lead_v2_lead_delete_unverified_deleteDeletesPermanently delete a lead by lead id. Destructive action; may require approval. API summary: Deletes a unverified lead object by id.
  • delete_merchandiseDeletesPermanently delete a merchandise by merchandise id. Destructive action; may require approval. API summary: Deletes a merchandise object by id.
  • delete_merchandise_productDeletesPermanently delete a product by product id. Destructive action; may require approval. API summary: Patches (partial update) a merchandise sku object by id.
  • delete_messageDeletesPermanently delete a message by type. Destructive action; may require approval. API summary: Remove email custom setting for a organization, campaign, event or collection.
  • delete_message_v2_email_instance_delete_deleteDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Deletes a email instance object by id.
  • delete_microblogDeletesPermanently delete a microblog by microblog id. Destructive action; may require approval. API summary: Deletes a microblog object by id.
  • delete_pageDeletesPermanently delete a page by page id. Destructive action; may require approval. API summary: Delete a PageUrl record by ID. Creates a shadow record for audit purposes before hard deletion.
  • delete_paymentDeletesPermanently delete a payment by payment id. Destructive action; may require approval. API summary: Removes (refund) a donation subscription payment object by id.
  • delete_refundDeletesPermanently delete a refund by refund id. Destructive action; may require approval. API summary: Deletes (cancels) a sale object by id.
  • delete_refund_installmentsMoves moneyPermanently delete a installment by sale id. Financial or irreversible action; may require approval. API summary: Stop collecting installment payments on a sale.
  • delete_sale_couponDeletesPermanently delete a sale coupon by sale coupon id. Destructive action; may require approval. API summary: Removes a SaleCoupon object by id.
  • delete_sale_coupon_instanceDeletesPermanently delete a instance by instance id. Destructive action; may require approval. API summary: Patches (partial update) a sale coupon instance object by id.
  • delete_sale_detailDeletesPermanently delete a sale detail by sale detail id. Destructive action; may require approval. API summary: Deletes (cancels) a sale detail object by id.
  • delete_sale_feeDeletesPermanently delete a sale fee by sale fee id. Destructive action; may require approval. API summary: Deletes a sale fee object by id.
  • delete_seriesDeletesPermanently delete a series by series id. Destructive action; may require approval. API summary: Deletes a series object by id.
  • delete_subscriptionDeletesPermanently delete a subscription by subscription id. Destructive action; may require approval. API summary: Patches (partial update) a donationSubscription object by id.
  • delete_taskDeletesPermanently delete a task by task id. Destructive action; may require approval. API summary: Patches (partial update) a fitnessActivity object by id.
  • delete_task_v2_fitness_activity_delete_deleteDeletesPermanently delete a task by task id. Destructive action; may require approval. API summary: Patches (partial update) a fitnessActivity object by id.
  • delete_terminalDeletesPermanently delete a terminal by terminal id. Destructive action; may require approval. API summary: Deletes a Terminal object by id.
  • delete_ticketDeletesPermanently delete a ticket by ticket key. Destructive action; may require approval. API summary: Deletes (cancels) a donationSubscription object by id.
  • delete_ticket_v2_ticket_delete_deleteDeletesPermanently delete a ticket by ticket id. Destructive action; may require approval. API summary: Deletes a ticket object by id.
  • export_access_keysChanges dataExport access keys. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_accountsChanges dataExport accounts. API summary: Search (List request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_accounts_exportChanges dataExport accounts. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_accounts_v2_account_fundraiser_post_export_postChanges dataExport accounts. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_accounts_v2_event_post_export_postChanges dataExport accounts. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_accounts_v2_fundraiser_post_export_postChanges dataExport accounts. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_accounts_v2_report_by_date_and_metric_post_export_postChanges dataExport accounts. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_campaign_ambassador_programsChanges dataExport campaign ambassador programs. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_campaign_organizersChanges dataExport campaign organizers. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_campaign_shipping_optionsChanges dataExport campaign shipping options. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_campaignsChanges dataExport campaigns. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_categoriesChanges dataExport categories. API summary: Search (List request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_categories_exportChanges dataExport categories. API summary: Search (List request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_companiesChanges dataExport companies. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_companies_exportDeletesExport companies. Destructive action; may require approval. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_customersChanges dataExport customers. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_donation_feesChanges dataExport donation fees. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_donationsChanges dataExport donations. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_event_ambassador_programsChanges dataExport event ambassador programs. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_event_ambassadorsChanges dataExport event ambassadors. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_event_organizersChanges dataExport event organizers. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_fitness_platform_linksChanges dataExport fitness platform links. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_franchisesChanges dataExport franchises. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_merchandisesChanges dataExport merchandises. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_messagesVisible to othersExport messages. Has effects visible outside this system. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_messages_exportVisible to othersExport messages. Has effects visible outside this system. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_microblogsChanges dataExport microblogs. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_pagesChanges dataExport pages. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_paymentsChanges dataExport payments. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_refundsChanges dataExport refunds. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_sale_couponsChanges dataExport sale coupons. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_sale_detailsChanges dataExport sale details. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_sale_feesChanges dataExport sale fees. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_seriesChanges dataExport series. API summary: Search (List request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_subscriptionsChanges dataExport subscriptions. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_tasksChanges dataExport tasks. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_tasks_exportChanges dataExport tasks. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • export_ticketsChanges dataExport tickets. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • get_a_setup_link_for_a_payment_platformList setups. Optional filters: type, platform, organization id or setup type. API summary: Get a setup link for a payment platform.
  • get_access_keyGet one access key by access key id. API summary: Gets a key object by id.
  • get_access_key_verifyGet one access key. API summary: Verify an object.
  • get_accountGet one account by account id. API summary: Gets an account object by id.
  • get_account_v2_content_moderation_get_event_getGet one account by account id. API summary: Returns the full event details for the review screen.
  • get_account_v2_data_retention_flag_get_account_retention_getGet one account by account id. API summary: Returns the live retention position for one account: last qualifying activity per rule and the date the account becomes eligible for anonymi….
  • get_account_v2_event_ambassador_program_get_by_event_getGet one account by account id. API summary: Gets a event ambassador program object by id.
  • get_account_v2_fitness_platform_link_get_fundraiser_setup_getGet one account by platform. API summary: Gets the oAuth URL to setup an fitness platform integration.
  • get_body_hash_clusterGet one body hash cluster by event id. Results are paginated. API summary: Returns recent events with a matching body hash to drive the cluster fan-out.
  • get_buyerGet one buyer account by its ID (passed as `customer_id`).
  • get_campaignGet one campaign by `campaign_id`, with its settings, targets and totals.
  • get_campaign_ambassador_programGet one campaign ambassador program by campaign ambassador program id. API summary: Gets a campaign ambassador program object object by id.
  • get_campaign_organizerGet one campaign organizer by campaign organizer id. API summary: Gets a key object by id.
  • get_campaign_shipping_optionGet one campaign shipping option by campaign shipping option id. API summary: Gets a key object by id.
  • get_campaign_v2_campaign_ambassador_program_get_by_campaign_id_gGet one campaign by campaign id. API summary: Gets a campaign ambassador program object object by id.
  • get_categoryGet one category by category id. API summary: Gets a collection object by id.
  • get_category_v2_collection_get_tree_by_path2_getGet one category by url path. API summary: Gets a collection object by paths.
  • get_category_v2_collection_get_tree_by_path_getGet one category by secondary path. API summary: Gets a collection object by paths.
  • get_companyGet one company by company id. API summary: Gets an organization object by id.
  • get_company_v2_organization_webhook_subscriber_get_getGet one company by company id. API summary: Gets an organization webhook subscriber object by id.
  • get_company_v2_organization_webhook_subscriber_get_samples_getGet one company by type. API summary: Gets webhook samples.
  • get_data_exportGet one data export by data export id. API summary: Gets a data export object by id.
  • get_donationGet one donation by `donation_id`, with amount, donor, message and payment details.
  • get_donation_feeGet one donation fee by donation fee id. API summary: Gets a donation fee object by id.
  • get_donorGet one donor account by `account_id`.
  • get_downloadGet one download by download id. API summary: Download a data export object by id.
  • get_eventGet one event by its ID (passed as `account_id`).
  • get_event_active_integrationGet one event active integration by event id. API summary: Gets a key object by id.
  • get_event_ambassadorGet one event ambassador by event ambassador id. API summary: Gets a event ambassador object by id.
  • get_event_ambassador_programGet one event ambassador program by event ambassador program id. API summary: Gets a event ambassador program object by id.
  • get_event_ambassador_statusChanges dataGet the current status of a event ambassador by event ambassador id. API summary: Updates a event ambassador object by id.
  • get_event_organizerGet one event organizer by event organizer id. API summary: Gets a key object by id.
  • get_externalGet one external by primary path. API summary: Public event summary for integration partners — event + live campaigns grouped by visible/enabled tiers.
  • get_fitness_platform_linkGet one fitness platform link by fitness platform link id. API summary: Gets a fitnessPlatformLink object by id.
  • get_franchiseGet one franchise by franchise id. API summary: Gets a Franchise by id, including its non-deleted editions.
  • get_fundraiserGet one fundraiser account by `account_id`.
  • get_fundraiser_pageGet one fundraiser page by its ID (passed as `account_id`), with target and amount raised.
  • get_identifierGet one identifier by identifier id. API summary: Gets a event ambassador object by id.
  • get_leadGet one lead by lead id. API summary: Gets a lead object by id.
  • get_merchandiseGet one merchandise by merchandise id. API summary: Gets a merchandise object by id.
  • get_messageGet one message by type. API summary: Gets email custom setting for a organization, campaign, event or collection.
  • get_message_v2_email_instance_get_getGet one message by message id. API summary: Gets a email instance object by id.
  • get_message_v2_email_log_get_getGet one message by message id. API summary: Gets a email log object by id.
  • get_microblogGet one microblog by microblog id. API summary: Gets a microblog object by id.
  • get_pageGet one page by scope key. API summary: Get PageUrl records by UrlScopeKey. Returns all records matching the given UrlScopeKey with linked entity information.
  • get_paymentGet one payment by payment id. API summary: Gets an donation subscription payment object by id.
  • get_payment_v2_sale_get_installment_manual_payment_getGet one payment by payment key. API summary: Get a previously created request for a new installment manual payment.
  • get_recurring_donationGet one recurring donation subscription by `subscription_id`.
  • get_saleGet one sale by its ID (passed as `refund_id`), with items, buyer and payment details.
  • get_sale_couponGet one sale coupon by sale coupon id. API summary: Gets a SaleCoupon object by id.
  • get_sale_detailGet one sale detail by sale detail id. API summary: Gets an sale detail object by id.
  • get_sale_feeGet one sale fee by sale fee id. API summary: Gets a sale fee object by id.
  • get_secureGet one secure by secure id. API summary: Gets a file from online storage and returns the new key for the uploaded file.
  • get_seriesGet one series by series id. API summary: Gets a series object by id.
  • get_subscriptionGet one subscription by secondary path. API summary: Gets a donation object by id.
  • get_subscription_v2_donation_subscription_get_path2_getGet one subscription by secondary path. API summary: Gets a donationSubscription object by id.
  • get_subscription_v2_donation_subscription_get_path_getGet one subscription by primary path. API summary: Gets a donationSubscription object by id.
  • get_summaryGet one summary by primary path. API summary: Event summary — same shape as the external summary, but tier visibility/enabled filtering is not applied.
  • get_taskGet one task by task id. API summary: Gets a fitnessActivity object by id.
  • get_task_v2_fitness_activity_get_getGet one task by task id. API summary: Gets a fitnessActivity object by id.
  • get_teamGet one team page by its ID (passed as `category_id`).
  • get_terminalGet one terminal by terminal code. API summary: Get a terminal configuration.
  • get_terminal_v2_terminal_get_getGet one terminal by terminal id. API summary: Gets a Terminal object by id.
  • get_ticketGet one ticket by `ticket_id`.
  • get_ticket_2Get one ticket by secondary path. API summary: Gets a campaign object by paths.
  • get_ticket_getGet one ticket by secondary url path.
  • get_ticket_v2_campaign_ambassador_program_get_by_path_getGet one ticket by secondary path. API summary: Gets a campaign ambassador program object object by paths.
  • get_ticket_v2_collection_get_by_path_getGet one ticket by url path. API summary: Gets a collection object by paths.
  • get_ticket_v2_donation_get_by_intent_public_getGet one ticket by ticket identifier. API summary: Gets a public donation object by donation intent identifier.
  • get_ticket_v2_donation_get_indentifier_getGet one ticket by ticket identifier. API summary: Gets a donation object by id.
  • get_ticket_v2_donation_subscription_get_indentifier_getGet one ticket by ticket key. API summary: Gets a donationSubscription object by id.
  • get_ticket_v2_event_ambassador_program_get_by_path_getGet one ticket by primary path. API summary: Gets a event ambassador program object by paths.
  • get_ticket_v2_event_get_by_path_getGet one ticket by url path. API summary: Gets a Event object by paths.
  • get_ticket_v2_foreign_rate_get_getGet one ticket by primary url path.
  • get_ticket_v2_fundraiser_get_by_path_getGet one ticket by url path. API summary: Gets a fundraiser object by paths.
  • get_ticket_v2_organization_get_by_path_getGet one ticket by url path. API summary: Gets a Organization object by paths.
  • get_ticket_v2_page_get_public2_getGet one ticket by secondary path. API summary: Gets a page object by paths.
  • get_ticket_v2_page_get_public3_getGet one ticket by url path. API summary: Gets a page object by paths.
  • get_ticket_v2_page_get_public_getGet one ticket by primary path. API summary: Gets a page object by paths.
  • get_ticket_v2_series_get_by_path_getGet one ticket by url path. API summary: Gets a series object by paths.
  • get_ticket_v2_team_get_by_path_getGet one ticket by url path. API summary: Gets a team object by paths.
  • list_account_auditsList audits for a account. API summary: The same history keyed on an account, for the account detail screen where the subject may never have had a flag row.
  • list_account_comparesList compares for a account. API summary: Gets events for comparison by franchise.
  • list_account_compares_v2_franchise_get_event_comparisons_by_editList compares for a account. API summary: Gets events for comparison by franchise edition.
  • list_accountsList accounts for a account. API summary: Gets an account integration object by id.
  • list_accounts_v2_account_get_audit_trail_getList accounts. Optional filters: organization id, target organization id, target campaign id, target event id, target donation id or target fundraiser id. Results are paginated. API summary: Gets paginated audit trail entries for all accounts (System Admin only).
  • list_accounts_v2_account_get_consent_events_getList accounts for a account. API summary: Gets the consent audit trail for an account.
  • list_accounts_v2_account_get_email_opt_getList accounts. Optional filters: instance types. API summary: Get Opt in or out from emails (donation, sale) current settings.
  • list_accounts_v2_content_moderation_get_account_cluster_getList accounts for a account. API summary: Pending events count for an account.
  • list_accounts_v2_report_by_date_and_metric_get_top_event_snapshoList accounts. Optional filters: date from or bracket. API summary: Returns a snapshot of the top event data for the day for a given event ID.
  • list_campaign_check_insList check ins for a campaign. Optional filters: updated after. API summary: Load all non-returned orders for a campaign that can be checked in.
  • list_campaign_comparesList compares for a campaign. API summary: Gets campaigns for comparison by franchise.
  • list_campaign_compares_v2_franchise_get_campaign_comparisons_by_List compares for a campaign. API summary: Gets campaigns for comparison by franchise edition.
  • list_campaign_feesList fees for a campaign. API summary: Gets a campaign object by id.
  • list_campaignsList campaigns. Optional filters: date from or bracket. API summary: Returns a snapshot of the top campaign data for the day for a given campaign ID.
  • list_companiesList companies. API summary: Gets the active Vero integration for an organization.
  • list_companies_v2_organization_get_vero_integration_history_getList companies. API summary: Gets the full Vero integration history for an organization (active + disabled).
  • list_companies_v2_report_by_date_and_metric_get_top_organizationList companies. Optional filters: date from or bracket. API summary: Returns a snapshot of the top organization data for the day for a given organization ID.
  • list_dailiesList dailies. Optional filters: date from, date to or bracket. API summary: Return a snapshot for a given date and bracket.
  • list_documentsList documents. API summary: Gets every published consent document version, newest first.
  • list_donation_relatedList related for a donation. API summary: Gets a donation object by id.
  • list_edition_snapshotsList snapshots for a edition. API summary: Gets a Franchise Edition snapshot with its linked entities (events or campaigns with financial data).
  • list_flag_auditsList audits for a flag. API summary: The audit history for a flagged subject: what was changed, by whom and when.
  • list_flag_retentionsList retentions for a flag. API summary: Returns the live retention position for a flagged subject, whether or not they have an account.
  • list_franchise_snapshotsList snapshots for a franchise. API summary: Gets a Franchise snapshot with all editions and their linked entities (events or campaigns with financial data).
  • list_metadataList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_account_buyer_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_account_donor_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_account_fundraiser_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_account_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_campaign_ambassador_program_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_campaign_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_campaign_organizer_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_campaign_shipping_option_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_collection_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_custom_activity_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_data_export_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_data_retention_flag_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_donation_fee_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_donation_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_donation_subscription_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_donation_subscription_payment_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_email_instance_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_email_log_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_event_ambassador_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_event_ambassador_program_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_event_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_event_organizer_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_fitness_activity_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_fitness_platform_link_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_franchise_get_metadata_getList metadata. API summary: Gets metadata describing Franchise fields.
  • list_metadata_v2_fundraiser_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_lead_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_leaderboard_by_amount_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_leaderboard_by_custom_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_leaderboard_by_fitness_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_merchandise_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_microblog_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_organization_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_organization_webhook_subscriber_get_metadata_geList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_page_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_report_by_date_and_metric_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_sale_coupon_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_sale_detail_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_sale_fee_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_sale_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_series_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_team_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_terminal_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_ticket_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_metadata_v2_timeline_get_metadata_getList metadata. API summary: Returns a list of filters that can be implemented and work nicely with /search.
  • list_pingsList pings. API summary: Pings and extends a session object.
  • list_queuesList queues. Optional filters: band, collection id, decision state, fundraiser id, linked account id or linked organization id. Results are paginated. API summary: Lists pending events for review, with band / score / subject filters.
  • list_refund_relatedList related for a refund. API summary: Gets a sale basic details and all linked records.
  • list_setupsList setups. Optional filters: platform, organization id, is reconnect or setup type. API summary: Get a setup link for a payment platform.
  • list_tasksList tasks. Optional filters: organization id, target organization id, target campaign id, target event id, target donation id or target fundraiser id. Results are paginated. API summary: Gets paginated account activity log entries with optional filtering.
  • pay_accountMoves moneyTransfer a account (fundraiser id). Financial or irreversible action; may require approval. API summary: Transfer a fundraiser object to another campaign.
  • pay_donationMoves moneyTransfer a donation (donation id). Financial or irreversible action; may require approval. API summary: Transfer a donation object to another campaign.
  • pay_event_ambassadorMoves moneyCharge a event ambassador (event ambassador id). Financial or irreversible action; may require approval. API summary: Creates a new event ambassador charge.
  • pay_subscriptionMoves moneyTransfer a subscription (donation subscription id). Financial or irreversible action; may require approval. API summary: Transfer a donation subscription object to another page.
  • refund_donationMoves moneyRefund an online donation by `donation_id`. Money goes back to the donor; this cannot be undone.
  • refund_installmentMoves moneyRefund a installment (installment id). Financial or irreversible action; may require approval. API summary: Perform a refund on an online sale installment.
  • refund_saleMoves moneyRefund an online sale by `sale_id`, optionally only part of it with `refund_amount`. Money goes back to the buyer; this cannot be undone.
  • refund_sale_detailMoves moneyRefund a sale detail (sale detail id). Financial or irreversible action; may require approval. API summary: Perform a refund on an online sale detail.
  • search_access_keysChanges dataSearch access keys. Use this to find existing access keys before creating a new access key. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_accountsChanges dataSearch accounts. Use this to find existing accounts before creating a new account. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_aggregatesSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_account_buyer_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_account_donor_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_account_fundraiser_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_campaign_ambassador_program_get_aggregate_gSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_campaign_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_collection_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_custom_activity_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_donation_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_donation_subscription_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_donation_subscription_payment_get_aggregateSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_event_ambassador_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_event_ambassador_program_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_event_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_fitness_activity_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_fitness_platform_link_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_fundraiser_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_lead_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_merchandise_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_microblog_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_organization_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_organization_webhook_subscriber_get_aggregaSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_page_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_sale_coupon_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_sale_detail_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_sale_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_series_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_team_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_aggregates_v2_ticket_get_aggregate_getSearch aggregates by field name, field aggregate, filters, text, order by key or order by direction. Use this to find existing aggregates before creating a new aggregate. Results are paginated. API summary: Perform an aggregate function on a field based on a filter/custom-text criteria.
  • search_buyersChanges dataSearch buyer accounts (people who bought tickets or merchandise) by `text`, with optional `filters` and paging.
  • search_campaign_ambassador_programsChanges dataSearch campaign ambassador programs. Use this to find existing campaign ambassador programs before creating a new campaign ambassador program. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_campaign_organizersChanges dataSearch campaign organizers. Use this to find existing campaign organizers before creating a new campaign organizer. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_campaign_shipping_optionsChanges dataSearch campaign shipping options. Use this to find existing campaign shipping options before creating a new campaign shipping option. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_campaignsChanges dataSearch fundraising campaigns by `text`, with optional `filters` (key/value) and paging (`page`, `page_size`). Returns campaign IDs and names.
  • search_categoriesChanges dataSearch categories. Use this to find existing categories before creating a new category. API summary: Search (List request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_companiesChanges dataSearch companies. Use this to find existing companies before creating a new company. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_companies_searchDeletesSearch companies. Use this to find existing companies before creating a new company. Destructive action; may require approval. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_data_exportsChanges dataSearch data exports. Use this to find existing data exports before creating a new data export. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_data_retention_flagsChanges dataSearch data retention flags. Use this to find existing data retention flags before creating a new data retention flag. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_daysChanges dataSearch days. Use this to find existing days before creating a new day. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_donation_feesChanges dataSearch donation fees. Use this to find existing donation fees before creating a new donation fee. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_donationsChanges dataSearch donations by `text` (e.g. donor name or email), with optional `filters` and paging.
  • search_donorsChanges dataSearch donor accounts by `text` (name or email), with optional `filters` and paging.
  • search_event_ambassador_programsChanges dataSearch event ambassador programs. Use this to find existing event ambassador programs before creating a new event ambassador program. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_event_ambassadorsChanges dataSearch event ambassadors. Use this to find existing event ambassadors before creating a new event ambassador. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_event_organizersChanges dataSearch event organizers. Use this to find existing event organizers before creating a new event organizer. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_eventsChanges dataSearch events by `text`, with optional `filters` and paging. Returns event IDs and names.
  • search_fitness_platform_linksChanges dataSearch fitness platform links. Use this to find existing fitness platform links before creating a new fitness platform link. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_franchisesChanges dataSearch franchises. Use this to find existing franchises before creating a new franchise. API summary: Searches for Franchises.
  • search_fundraiser_pagesChanges dataSearch fundraiser pages (individual fundraising pages) by `text`, with optional `filters` and paging.
  • search_fundraisersChanges dataSearch fundraiser accounts (people who fundraise) by `text` (name or email), with optional `filters` and paging.
  • search_leadsChanges dataSearch leads. Use this to find existing leads before creating a new lead. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_merchandisesChanges dataSearch merchandises. Use this to find existing merchandises before creating a new merchandise. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_messagesVisible to othersSearch messages. Use this to find existing messages before creating a new message. Has effects visible outside this system. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_messages_searchVisible to othersSearch messages. Use this to find existing messages before creating a new message. Has effects visible outside this system. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_microblogsChanges dataSearch microblogs. Use this to find existing microblogs before creating a new microblog. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_monthsChanges dataSearch months. Use this to find existing months before creating a new month. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_pagesChanges dataSearch pages. Use this to find existing pages before creating a new page. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_paymentsChanges dataSearch payments. Use this to find existing payments before creating a new payment. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_recurring_donationsChanges dataSearch recurring donation subscriptions by `text`, with optional `filters` and paging.
  • search_sale_couponsChanges dataSearch sale coupons. Use this to find existing sale coupons before creating a new sale coupon. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_sale_detailsChanges dataSearch sale details. Use this to find existing sale details before creating a new sale detail. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_sale_feesChanges dataSearch sale fees. Use this to find existing sale fees before creating a new sale fee. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_salesChanges dataSearch sales (ticket and merchandise orders) by `text`, with optional `filters` and paging.
  • search_seriesChanges dataSearch series. Use this to find existing series before creating a new series. API summary: Search (List request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_tasksChanges dataSearch tasks. Use this to find existing tasks before creating a new task. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_tasks_searchChanges dataSearch tasks. Use this to find existing tasks before creating a new task. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_teamsChanges dataSearch team pages by `text`, with optional `filters` and paging.
  • search_terminalsChanges dataSearch terminals. Use this to find existing terminals before creating a new terminal. API summary: Search (list request) of a set of objects based on a list of filters, text, paging and ordering parameters.
  • search_ticketsChanges dataSearch tickets by `text` (e.g. attendee name or email), with optional `filters` and paging.
  • send_account_journey_custom_entriesVisible to othersEmail a account (event id). Has effects visible outside this system. API summary: Gets email journey custom entries for an event.
  • send_campaign_journey_custom_entriesVisible to othersEmail a campaign (campaign id). Has effects visible outside this system. API summary: Gets email journey custom entries for a campaign including organization and event entries.
  • send_company_journey_custom_entriesVisible to othersEmail a company (organization id). Has effects visible outside this system. API summary: Gets email journey custom entries for an organization.
  • send_messageDeletesEmail a message. Destructive action; may require approval. API summary: Updates email custom setting for a organization, campaign, event or collection.
  • send_message_emailVisible to othersEmail a message. Has effects visible outside this system. API summary: Creates a new email instance.
  • submit_accountVisible to othersActivate a account (account id). Has effects visible outside this system. API summary: Creates a new account multi factor entry.
  • submit_account_copyVisible to othersCopy a account (event id). Has effects visible outside this system. API summary: Duplicates a event object given an id.
  • submit_account_lockVisible to othersLock a account (event id). Has effects visible outside this system. API summary: Acquires the review lock for the calling reviewer.
  • submit_account_mark_spamVisible to othersMark spam a account (fundraiser id). Has effects visible outside this system. API summary: Marks a fundraiser as spam. Sys admin only. Archives the page, makes it private, sets a redirect to the campaign's main URL, flags and locks….
  • submit_campaignVisible to othersCopy a campaign (campaign id). Has effects visible outside this system. API summary: Duplicates a campaign object given an id.
  • submit_categoryVisible to othersMark spam a category (collection id). Has effects visible outside this system. API summary: Marks a collection as spam. Sys admin only. Archives the page, sets a redirect to the campaign's main URL, flags and locks the owner account….
  • submit_category_mark_spamVisible to othersMark spam a category (team id). Has effects visible outside this system. API summary: Marks a team as spam. Sys admin only. Archives the page, makes it private, sets a redirect to the campaign's main URL, flags and locks the o….
  • submit_linkVisible to othersRefresh a link (organization id). Has effects visible outside this system. API summary: Checks with Swiftaid whether an organization has warranted this platform as a source of Gift Aid eligible donations, and updates the stored….
  • submit_paymentVisible to othersComplete a payment (sale id). Has effects visible outside this system. API summary: Complete a request for a new installment manual payment.
  • submit_sessionVisible to othersActivate a session. Has effects visible outside this system. API summary: Creates a session through an activate procedure, requiring an activation code.
  • update_accountChanges dataUpdate an existing account identified by account id. Only the fields you pass are changed. API summary: Patches (partial update) an account object by id.
  • update_account_demoteDeletesUpdate an existing demote identified by admin membership id. Destructive action; may require approval. API summary: Demotes an account single admin membership.
  • update_account_v2_account_post_event_invite_postVisible to othersUpdate an existing account identified by account url path. Has effects visible outside this system. API summary: Creates a new account event invite.
  • update_account_v2_account_post_promotion_organization_postChanges dataUpdate an existing account identified by organization id. API summary: Promotes an account.
  • update_account_v2_collection_post_fundraiser_link_operation_postChanges dataUpdate an existing account identified by account id. API summary: Creates a new collection/fundraiser link.
  • update_accountsVisible to othersUpdate an existing account identified by account id. Has effects visible outside this system. API summary: Creates a new account integration.
  • update_accounts_v2_event_ambassador_reset_status_putVisible to othersUpdate an existing account identified by event ambassador id. Has effects visible outside this system. API summary: Resets a event ambassador status by id.
  • update_bulksVisible to othersUpdate an existing bulk. Has effects visible outside this system. API summary: Update 1 or more terminals organization and campaign settings.
  • update_campaignChanges dataUpdate a campaign by `campaign_id` using JSON Patch operations in `items` (op, path, value), e.g. op 'replace' on a field path.
  • update_campaign_ambassador_programChanges dataUpdate an existing campaign ambassador program identified by campaign ambassador program id. Only the fields you pass are changed. API summary: Patches (partial update) a campaign ambassador program object object by id.
  • update_campaign_ambassador_program_activationsVisible to othersUpdate an existing activation identified by campaign ambassador program id. Has effects visible outside this system. API summary: Updates a campaign ambassador program object object by id.
  • update_campaign_ambassador_program_seatsVisible to othersUpdate an existing seat identified by campaign ambassador program id. Has effects visible outside this system. API summary: Updates a campaign ambassador program object object by id.
  • update_campaign_organizerChanges dataUpdate an existing campaign organizer identified by campaign organizer id. Only the fields you pass are changed. API summary: Patches (partial update) a key object by id.
  • update_campaign_shipping_optionChanges dataUpdate an existing campaign shipping option identified by campaign shipping option id. Only the fields you pass are changed. API summary: Patches (partial update) a key object by id.
  • update_categoryChanges dataUpdate an existing category identified by category id. Only the fields you pass are changed. API summary: Patches (partial update) a collection object by id.
  • update_category_v2_collection_post_team_link_operation_postChanges dataUpdate an existing category identified by category id. API summary: Creates a new collection/team link.
  • update_companyChanges dataUpdate an existing company identified by company id. Only the fields you pass are changed. API summary: Patches (partial update) an organization object by id.
  • update_company_v2_organization_webhook_subscriber_patch_patchDeletesUpdate an existing company identified by company id. Only the fields you pass are changed. Destructive action; may require approval. API summary: Patches (partial update) an organization webhook subscriber object by id.
  • update_donationChanges dataUpdate a donation by `donation_id` using JSON Patch operations in `items` (op, path, value), e.g. to change the display name or message.
  • update_donation_feeChanges dataUpdate an existing donation fee identified by donation fee id. Only the fields you pass are changed. API summary: Patches (partial update) a donation fee object by id.
  • update_donation_repliesVisible to othersUpdate an existing reply identified by donation id. Has effects visible outside this system. API summary: Creates a new donation message reply.
  • update_donation_terminalsVisible to othersUpdate an existing terminal identified by donation id. Has effects visible outside this system. API summary: Completes a terminal donation.
  • update_event_active_integrationChanges dataUpdate an existing event active integration identified by event id. API summary: Updates a the active integration for an event by eventId.
  • update_event_ambassadorChanges dataUpdate an existing event ambassador identified by event ambassador id. Only the fields you pass are changed. API summary: Patches (partial update) a event ambassador object by id.
  • update_event_ambassador_claimsVisible to othersUpdate an existing claim identified by event ambassador id. Has effects visible outside this system. API summary: Updates a event ambassador object by id.
  • update_event_ambassador_fundraisersVisible to othersUpdate an existing fundraiser identified by event ambassador id. Has effects visible outside this system. API summary: Updates a event ambassador object by id.
  • update_event_ambassador_programChanges dataUpdate an existing event ambassador program identified by event ambassador program id. Only the fields you pass are changed. API summary: Patches (partial update) a event ambassador program object by id.
  • update_event_ambassador_registrationsVisible to othersUpdate an existing registration identified by event ambassador id. Has effects visible outside this system. API summary: Sets the registration data for a event ambassador by id.
  • update_event_organizerChanges dataUpdate an existing event organizer identified by event organizer id. Only the fields you pass are changed. API summary: Patches (partial update) a key object by id.
  • update_franchiseChanges dataUpdate an existing franchise identified by franchise id. API summary: Updates a Franchise and its editions.
  • update_leadChanges dataUpdate an existing lead identified by lead id. Only the fields you pass are changed. API summary: Patches (partial update) a lead object by id.
  • update_lead_v2_lead_post_unverified_postChanges dataUpdate an existing lead identified by secondary path. API summary: Creates a new unverified lead.
  • update_merchandiseChanges dataUpdate an existing merchandise identified by merchandise id. Only the fields you pass are changed. API summary: Patches (partial update) a merchandise object by id.
  • update_merchandise_productChanges dataUpdate an existing product identified by product id. API summary: Updates a merchandise sku object by id.
  • update_messageVisible to othersUpdate an existing message identified by message id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Patches (partial update) a email instance object by id.
  • update_microblogChanges dataUpdate an existing microblog identified by microblog id. Only the fields you pass are changed. API summary: Patches (partial update) a microblog object by id.
  • update_refund_check_inChanges dataUpdate an existing check in identified by sale detail id. API summary: Check in a specific sale detail and mark the sale as checked in if all details are now checked in.
  • update_refund_customersVisible to othersUpdate an existing customer identified by sale id. Has effects visible outside this system. API summary: Updates a sale object by id.
  • update_sale_couponChanges dataUpdate an existing sale coupon identified by sale coupon id. Only the fields you pass are changed. API summary: Patches (partial update) a SaleCoupon object by id.
  • update_sale_coupon_instanceChanges dataUpdate an existing instance identified by instance id. API summary: Updates a SaleCoupon Instance object by id.
  • update_sale_detail_customersVisible to othersUpdate an existing customer identified by sale detail id. Has effects visible outside this system. API summary: Updates a sale detail object by id.
  • update_sale_feeChanges dataUpdate an existing sale fee identified by sale fee id. Only the fields you pass are changed. API summary: Patches (partial update) a sale fee object by id.
  • update_seriesChanges dataUpdate an existing series identified by series id. Only the fields you pass are changed. API summary: Patches (partial update) a series object by id.
  • update_subscriptionChanges dataUpdate an existing subscription identified by subscription id. API summary: Updates a new donation intent.
  • update_subscription_v2_donation_subscription_patch_patchChanges dataUpdate an existing subscription identified by subscription id. Only the fields you pass are changed. API summary: Patches (partial update) a donationSubscription object by id.
  • update_subscription_v2_sale_get_postChanges dataUpdate an existing subscription identified by secondary path. API summary: Gets a sale object by id.
  • update_subscriptionsVisible to othersUpdate an existing subscription. Has effects visible outside this system. API summary: Obtains a new donationSubscription payment method change request for an existing Donation Subscription.
  • update_taskChanges dataUpdate an existing task identified by task id. Only the fields you pass are changed. API summary: Patches (partial update) a fitnessActivity object by id.
  • update_task_v2_fitness_activity_patch_patchChanges dataUpdate an existing task identified by task id. Only the fields you pass are changed. API summary: Patches (partial update) a fitnessActivity object by id.
  • update_terminalChanges dataUpdate an existing terminal identified by terminal id. API summary: Updates a Terminal object by id.
  • update_ticketChanges dataUpdate an existing ticket identified by ticket key. API summary: Updates a donationSubscription object by id.
  • update_ticket_v2_ticket_patch_patchChanges dataUpdate an existing ticket identified by ticket id. Only the fields you pass are changed. API summary: Patches (partial update) a ticket object by id.
  • upload_documentChanges dataUpload a document (type). API summary: Uploads a file to online storage and returns the new key for the uploaded file.
  • upload_secureChanges dataUpload a secure (type). API summary: Uploads a file to online storage and returns the new key for the uploaded file.

Set up in three steps

  1. 1

    Pick the app

    Create a free HeyMyApps account and choose Grassrootz from the app list.

  2. 2

    Paste your key

    Paste the Client Secret and the Client Key from Grassrootz. API keys are issued on request: ask your Grassrootz support representative or client success manager for one. The Client Secret goes in the token field and the Client Key in the ApiKey field.

  3. 3

    Add the link to your AI

    You get a personal MCP link. Add it to Claude, ChatGPT or Cursor:

    1. Click your name, then Settings › Connectors › Add custom connector.
    2. Paste your link as the Remote MCP server URL.
    3. Switch it on from the + menu in a chat.

Questions

What can the AI do in Grassrootz?

The AI can search and read campaigns, events, teams, fundraiser pages, donors, fundraisers, donations, recurring donations, sales, buyers and tickets. It can update campaigns and donations, and refund online donations and online sales.

Does the AI see my Grassrootz credentials?

No. Your Grassrootz Client Key and Client Secret are encrypted at rest and never shown to the AI. After you save them, they are not shown again, not even to you. The AI only sees the results of the tools it calls.

Can I control what the AI is allowed to do?

Yes. You choose which tools are switched on, so you can start with searches only. Refunds send money back to the donor or buyer and cannot be undone, so refund_donation and refund_sale can require your approval before they run, or stay off. Every tool call is logged.

Does it work with ChatGPT?

Yes. In ChatGPT go to Settings › Apps & Connectors › Advanced and turn on Developer mode, then add your HeyMyApps link. Developer mode needs a paid ChatGPT plan: Plus, Pro, Business or Enterprise. The same link also works in Claude (Settings › Connectors › Add custom connector), Cursor and other MCP clients.

What does it cost?

HeyMyApps has a free plan with no credit card required. Paid plans bill per completed task. You also need your own Grassrootz account.

How do I get a Grassrootz API key?

Grassrootz issues API keys on request. Ask your Grassrootz support representative or client success manager, and you get a Client Key and a Client Secret. A key has the same permissions as an organisation administrator, so switch on only the HeyMyApps tools you need.

Let your AI work in Grassrootz today.

Start free. Your key stays encrypted, and you decide what the AI may do.

Connect Grassrootz free

HeyMyApps is not affiliated with Grassrootz. Product names are trademarks of their owners.