latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Campaigns

Get a campaign

This request allows you to read your Fundraise Up campaign record. Only base campaign types are supported.

get/v1/campaigns/{id}

Path parameters

idstring required

Example:FUNXXXXXXXX

Unique identifier of the campaign, formatted as FUN[A-Z\d]{8}.

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. Campaigns only exist in live mode — set this to true.

Response

On success, the API returns the campaign object.

campaign_page_urlstring nullable required

Public URL of the campaign page.

codestring nullable required

Campaign code, as set in the Dashboard.

currency'shp' | 'eur' | 'aed' | 'afn' | 'xcd' | 'all' | 'amd' | 'aoa' | 'ars' | 'usd' | 'aud' | 'ang' | 'xcg' | 'awg' | 'azn' | 'bam' | 'bbd' | 'inr' | 'pkr' | 'bdt' | 'xof' | 'bgn' | 'bhd' | 'bif' | 'bmd' | 'myr' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'btn' | 'nok' | 'zar' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'xaf' | 'chf' | 'nzd' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'mad' | 'etb' | 'fjd' | 'fkp' | 'jpy' | 'gbp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'hrk' | 'htg' | 'huf' | 'idr' | 'ils' | 'isk' | 'jmd' | 'jod' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kwd' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'mzn' | 'nad' | 'xpf' | 'ngn' | 'nio' | 'sek' | 'npr' | 'omr' | 'pab' | 'pen' | 'pgk' | 'php' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sgd' | 'sll' | 'sle' | 'sos' | 'srd' | 'std' | 'svc' | 'szl' | 'thb' | 'tjs' | 'tnd' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'yer' | 'zmw' | 'btc' | 'eth' | 'usdt' | 'usdc' | 'sol' | 'dot' | 'doge' | 'shib' | 'ltc' | 'bch' | 'xtz' | 'fil' | 'ftm' | 'gala' | 'paxg' | 'zec' required

Three-letter ISO currency code, in lowercase.

designation_mode'select' | 'assign' required

Designation selection mode.

end_datestring nullable required

Timestamp in ISO 8601 format, indicating when the campaign ends in UTC. null if no end date is set.

idstring required

Unique campaign identifier.

namestring required

Campaign name.

status'active' | 'disabled' | 'auto_archive' required

Current status of the campaign.

tagsstring[] required

Campaign tags, as set in the Dashboard.

Example response

{
  "account": {
    "code": "Code-1",
    "id": "AXXXXXXX",
    "name": "Example Account"
  },
  "campaign_page_url": "https://org.fundraiseup.com/page/FUNXXXXXXXX",
  "code": "Code-1",
  "currency": "usd",
  "designation_mode": "select",
  "designations": [
    {
      "code": "GEN-01",
      "frequencies": [
        "once",
        "monthly"
      ],
      "id": "EXXXXXXX",
      "is_default": true,
      "name": "General Fund",
      "type": "designation"
    }
  ],
  "end_date": "2026-12-31T00:00:00.000Z",
  "frequencies": [
    {
      "minimum_amount": "5.00",
      "type": "monthly"
    }
  ],
  "id": "FUNXXXXXXXX",
  "name": "My Campaign",
  "status": "active",
  "tags": [
    "annual",
    "general"
  ]
}