FUfundraiseup
Fundraisers

Get a Fundraiser

Changed on

This request allows you to retrieve a Fundraiser record from your Fundraise Up account. Webhooks are not supported.

get/v1/fundraisers/{id}

Request

  • Base URL
    https://api.fundraiseup.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:NXXXXXXX

Unique identifier of the Fundraiser, formatted as N[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. Fundraisers only exist in live mode — set this to true.

Response

On success, the API returns the Fundraiser object. If parameters are invalid, the call will return an error.

codestring nullable required

Code for the fundraiser, if applicable.

created_atstring required

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

currency'shp' | 'eur' | 'aed' | 'afn' | 'xcd' | 'all' | 'amd' | 'aoa' | 'ars' | 'usd' | 'aud' | 'ang' | 'xcg' | 'awg' | 'azn' | 'bam' | 'bbd' | 'inr' | 'pkr' | 'bdt' | 'xof' | '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' | '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' | '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' | 'sle' | 'sos' | 'srd' | 'szl' | 'thb' | 'tjs' | 'tnd' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'yer' | 'zmw' required

Three-letter ISO currency code, in lowercase.

descriptionstring required

Description of the Fundraiser.

idstring required

Unique identifier for the Fundraiser.

namestring required

The title of the Fundraiser, used as its main heading.

slugstring nullable required

Slug for the Fundraiser, if set.

status'active' | 'paused' required

Current status of the Fundraiser.

Example response

{
  "campaign": {
    "code": "Code-1",
    "id": "FUNXXXXXXXX",
    "name": "My Campaign"
  },
  "created_at": "2024-12-20T00:00:00.000Z",
  "currency": "usd",
  "designation": {
    "code": "Code-1",
    "id": "EXXXXXXX",
    "name": "My Designation"
  },
  "name": "Run for hope"
}

Changes

  • 12bc2c7512aaRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      added the new xcg enum value to the response property for the response status

    • info

      added the new optional query request parameter livemode

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed the bgn enum value from the response property for the response status

    • info

      added the required property to the response with the status

  • 2bc52146b36fRevision changes
    • info

      endpoint added