latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Campaigns

Get campaigns

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

get/v1/campaigns

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.

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

accountstring

The ID of the account to filter by, formatted as [A-Z\d]{8}.

designationstring

The ID of the designation to filter by, formatted as E[A-Z\d]{7}.

Response

On success, the API returns the list of campaigns.

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"
      },
      "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"
      ]
    }
  ],
  "has_more": true
}