latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Supporters

Get supporters

Use this request to retrieve a paginated list of supporter records from your Fundraise Up account. Each record includes the latest contact details and other supporter-level fields, matching the data shown in the Supporters view in the Dashboard.

About supporter contact data

The address, phone, and employer fields in supporter records reflect the most recent information provided by the supporter.

These fields are updated automatically when:

  • The supporter makes a new donation using the same email address.
  • A donation or recurring plan is edited in the Dashboard.
  • The supporter updates their details in the Donor Portal.

Installments do not update supporter-level contact data.

You can't edit supporter contact fields through the API. To change them, update the associated donation or recurring plan — in the Dashboard at any time, or through the API within 24 hours of creation. The supporter record will reflect the updated values automatically.

This behavior applies only to changes made after June 2, 2025. Data collected earlier is not updated retroactively.

Tracking updates using the Events endpoint

To monitor changes to supporter contact data, use the Events endpoint. The following events may indicate a change to supporter contact fields:

  • supporter.updated — supporter-level data has changed.
  • donation.updated — contact fields on a donation were modified.
  • recurring_plan.details_updated — a recurring plan was edited.

When you receive one of these events, use the corresponding endpoints to retrieve updated data:

  • GET /supporters/{id} — get supporter-level contact information.
  • GET /donations/{id} — get contact details specific to a donation.
  • GET /recurring_plans/{id} — get contact details specific to a recurring plan.
get/v1/supporters

Query parameters

livemodeboolean
Example:true

Specifies whether the request is executed in live or test mode. Required for API keys created after 30th January 2026.

created[gt]string date-time

Minimum creation date (exclusive). Returns records after this timestamp.

created[gte]string date-time

Minimum creation date (inclusive). Returns records from and after this timestamp.

created[lt]string date-time

Maximum creation date (exclusive). Returns records before this timestamp.

created[lte]string date-time

Maximum creation date (inclusive). Returns records up to and including this timestamp.

{
  "created[gt]": "2025-01-01T12:30:00+02:00",
  "created[gte]": "2025-01-01T12:30:00+02:00",
  "created[lt]": "2025-01-01T12:30:00+02:00",
  "created[lte]": "2025-01-01T12:30:00+02:00"
}
starting_afterstring

A cursor for pagination. Returns records older than the specified object ID.

ending_beforestring

A cursor for pagination. Returns records newer than the specified object ID.

limitinteger

This parameter specifies the number of records to display per page, ranging from 1 to 100

Response

On success, the API returns the list of supporters.

has_moreboolean required

Indicates whether there are more records available. For starting_after, it shows that there is a page with older records. For ending_before, it indicates that there is a page with newer records.

Example response

{
  "data": [
    {
      "account": {
        "code": "Code-1",
        "id": "AXXXXXXX",
        "name": "Example Account"
      },
      "address": {
        "city": "Nashville",
        "country": "us",
        "line1": "123 Example St.",
        "line2": "Apt. 1",
        "postal_code": "111111",
        "region": "Tennessee"
      },
      "created_at": "2024-12-20T00:00:00.000Z",
      "email": "example@example.com",
      "employer": {
        "name": "Fundraise Up Inc."
      },
      "employment_status": "employed",
      "first_name": "Alex",
      "id": "SXXXXXXXX",
      "language": "en-CA",
      "last_name": "Garcia",
      "livemode": true,
      "occupation": "Software Engineer",
      "phone": "+1 (111) 111111",
      "title": "mr"
    }
  ],
  "has_more": true
}