Skip to main content
GET
Get a Campaign
The response covers the campaign’s date range, its giving, total gift, and average gift goals, and the progress against them: raisedAmount, totalGifts, totalDonors, totalVisitors, and conversionRate.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

id
integer<int64>
required

The ID of the campaign.

Response

OK

Represents the detailed view of a campaign returned by create, update, and single-campaign retrieval endpoints.

id
integer<int64>

The unique identifier of the campaign.

name
string | null

The name of the campaign.

description
string | null

The description of the campaign.

startDate
string | null
read-only

The date the campaign starts.

endDate
string | null
read-only

The date the campaign ends.

duration
string | null
read-only

The length of the campaign in days.

canSync
boolean
read-only

Whether the campaign can sync to your CRM.

crmKey
string | null

The key that links the campaign to the matching record in your CRM.

crmKeyUrls
object | null

CRM URLs for this campaign grouped by integration type.

applySegmentToRecurringGifts
boolean

Whether the segment applies to recurring gifts.

givingGoal
number<double>

The giving goal for the campaign in the organization base currency.

givingGoalFormatted
string | null
read-only

The giving goal formatted for display in the organization currency (for example "$10,000.00").

hasGivingGoal
boolean

Whether the campaign has a giving goal.

raisedAmount
string | null
read-only

The total amount raised by the campaign.

raisedPercentage
number<double>
read-only

Percentage of the giving goal that has been raised (0–100).

totalGiftGoal
integer<int32>

The number of gifts the campaign aims to bring in.

hasTotalGiftGoal
boolean

Whether the campaign has a total gift goal.

totalGifts
integer<int32>
read-only

The number of gifts recorded for the campaign.

totalGiftsPercentage
number<double>
read-only

Percentage of the gift count goal that has been reached (0–100).

totalDonors
integer<int32>
read-only

The number of donors who have given to the campaign.

averageGiftGoal
number<double>

The target average gift amount in the organization base currency.

averageGiftGoalFormatted
string | null
read-only

The target average gift amount formatted for display (for example "$100.00").

averageGiftAmount
string | null
read-only

The actual average gift amount formatted for display.

hasAverageGiftGoal
boolean

Whether the campaign has an average gift goal.

totalVisitors
integer<int32>
read-only

The number of visitors recorded for the campaign.

conversionRate
string | null
read-only

The conversion rate for the campaign formatted as a percentage string (for example "12.3%").

createdDateTime
string | null
read-only

The UTC date and time the campaign was created.

modifiedDateTime
string | null
read-only

The UTC date and time the campaign was last modified.

Last modified on July 28, 2026