Skip to main content
GET
Get Campaigns

Authorizations

x-client-id
string
header
required

Client ID for API authentication

x-api-key
string
header
required

API Key for API authentication

Query Parameters

limit
number
default:25

The number of campaigns to return.

Required range: 1 <= x <= 100
page
number
default:1

The page number of the campaigns to return.

Required range: x >= 1
includeArchived
boolean

Whether to include campaigns that have been archived.

sortBy
enum<string>
default:startDate

The field to sort the campaigns by.

Available options:
endDate,
name,
startDate,
displayOrder,
totalContributionCount,
totalContributionValue,
uniqueDonorCount
Example:

"startDate"

sortDirection
enum<string>
default:DESC

The direction to sort the campaigns by.

Available options:
ASC,
DESC
Example:

"DESC"

isSubcampaign
enum<string>
default:false

Whether to return subcampaigns or campaigns. If true, returns subcampaigns, otherwise returns campaigns

Available options:
true,
false
Example:

false

parentCampaignId
string

The id of the parent campaign to return subcampaigns for.

excludeInactive
boolean

Whether to exclude campaigns that have ended.

Search by campaign name.

Example:

"Summer Camp"

Response

200 - application/json
data
object[]
required

List of campaigns.

totalCount
number
required

Total number of campaigns matching the filters.

Example:

100

Last modified on July 14, 2026