latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Supporters

Get a supporter

Use this request to retrieve a specific supporter record by its unique ID. The response includes all supporter-level fields available in the Dashboard, such as name, email, language, mailing address, phone number, employer, and others.

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. 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/{id}

Path parameters

idstring required

Example:SXXXXXXX

Unique identifier of the supporter, formatted as S[A-Z]{7}.

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.

Response

On success, the API returns the supporter object.

created_atstring required

Timestamp in ISO 8601 format, indicating when the supporter was created, in UTC.

emailstring nullable required

Email address associated with the supporter.

employment_status'employed' | 'unemployed' | 'retired' nullable required

The supporter's current employment status. Possible values: employed, unemployed, retired. Returns null if not collected. Only collected for US political organizations.

first_namestring nullable required

First name of the supporter.

idstring required

Unique identifier for the supporter.

language'en-US' | 'en-GB' | 'en-CA' | 'fr-CA' | 'fr-FR' | 'es' | 'nl' | 'no' | 'de' | 'de-x-informal' | 'fi-FI' | 'ar-001' | 'sv' | 'it' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'zh-TW' | 'ja' | 'ko' | 'hu' | 'da' | 'ru-RU' | 'es-US' | 'pl-PL' | 'he' required

Supporter's locale.

last_namestring nullable required

Last name of the supporter.

livemodeboolean required

Test mode indicator. true for supporters in live mode, false for supporters in test mode.

occupationstring nullable required

The supporter's current occupation. Returns null if not collected or if employment status is unemployed or retired. Max 200 characters.

phonestring nullable required

Supporter's phone number.

title'm' | 'mme' | 'mlle' | 'autre' | 'mx' | 'mr' | 'mrs' | 'miss' | 'ms' | 'sir' | 'dame' | 'lord' | 'lady' | 'dr' | 'prof' | 'rev' | 'fr' | 'dcn' | 'br' | 'sr' | 'frau' | 'herr' | 'frau dr.' | 'herr dr.' | 'frau prof.' | 'herr prof.' nullable required

Supporter's title.

Example response

{
  "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"
}