Sign in
latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Designation configurations

Get designation configurations

Use this request to retrieve a paginated list of designation configurations from your Fundraise Up account. Each configuration represents a relationship between a designation and a campaign, and specifies which payment frequencies are allowed.

get/v1/designation_configurations

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

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

campaignstring

The ID of the campaign to filter by.

designationstring

The ID of the designation to filter by.

repeat'recurring' | 'one-time' | 'all'
Example:all

Indicates payment types accepted for this designation-campaign combination.

Response

On success, the API returns a list of designation configurations. The response includes an array of configuration objects and a boolean indicating whether more records are available.

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": {
        "code": "Code-1",
        "id": "FUNXXXXXXXX",
        "name": "My Campaign"
      },
      "created_at": "2024-12-20T00:00:00.000Z",
      "designation": {
        "code": "Code-1",
        "id": "EXXXXXXX",
        "name": "My Designation"
      },
      "id": "MXXXXXXX",
      "repeat": "all"
    }
  ],
  "has_more": true
}