Get Campaign/Subcampaign

curl --request GET \
  --url https://server.stage.overflow.co/api/v3/campaigns/{campaignId} \
  --header 'x-client-id: <api-key>'

{
  "data": {
    "id": "7710f34fd5061afeec3eab59",
    "archivedAt": "2025-01-01T00:00:00.000Z",
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z",
    "name": "Builders Fundraiser",
    "startDate": "2025-01-01T00:00:00.000Z",
    "endDate": "2025-12-01T00:00:00.000Z",
    "status": "ACTIVE",
    "displayOrder": 1,
    "isSubcampaign": false,
    "hideFromDonors": false,
    "parentCampaigns": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "subcampaigns": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "applyToAllCampaigns": true,
    "totalContributionCount": 100,
    "totalContributionValue": 1000,
    "uniqueDonorCount": 100
  }
}

GET

api

campaigns

{campaignId}

Get Campaign/Subcampaign

curl --request GET \
  --url https://server.stage.overflow.co/api/v3/campaigns/{campaignId} \
  --header 'x-client-id: <api-key>'

{
  "data": {
    "id": "7710f34fd5061afeec3eab59",
    "archivedAt": "2025-01-01T00:00:00.000Z",
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z",
    "name": "Builders Fundraiser",
    "startDate": "2025-01-01T00:00:00.000Z",
    "endDate": "2025-12-01T00:00:00.000Z",
    "status": "ACTIVE",
    "displayOrder": 1,
    "isSubcampaign": false,
    "hideFromDonors": false,
    "parentCampaigns": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "subcampaigns": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "applyToAllCampaigns": true,
    "totalContributionCount": 100,
    "totalContributionValue": 1000,
    "uniqueDonorCount": 100
  }
}

Authorizations

x-client-id

string

header

required

Client ID for API authentication

Path Parameters

campaignId

string

required

The Id of the campaign/subcampaign to get.

Example:

"2ea1ae03ca521e437db76d76"

Response

data

object

required

Campaign for the given id.

Show child attributes

data.id

string

required

Campaign Id

Example:

"7710f34fd5061afeec3eab59"

data.archivedAt

string<date-time> | null

required

Campaign archived at

Example:

"2025-01-01T00:00:00.000Z"

data.createdAt

string<date-time>

required

Campaign created at

Example:

"2025-01-01T00:00:00.000Z"

data.updatedAt

string<date-time>

required

Campaign updated at

Example:

"2025-01-01T00:00:00.000Z"

data.name

string

required

Campaign name

Example:

"Builders Fundraiser"

data.startDate

string<date-time>

required

Campaign start date

Example:

"2025-01-01T00:00:00.000Z"

data.endDate

string<date-time> | null

required

Campaign end date

Example:

"2025-12-01T00:00:00.000Z"

data.status

enum<string>

required

Campaign status

Available options:

ACTIVE,

ARCHIVED,

EXPIRED,

UPCOMING

Example:

"ACTIVE"

data.displayOrder

number | null

required

Campaign display order

Example:

1

data.isSubcampaign

boolean

default:false

Whether the campaign is a subcampaign

data.hideFromDonors

boolean

default:false

Whether the campaign is hidden from donors

data.parentCampaigns

object[]

List of parent campaigns if the campaign is a subcampaign

Show child attributes

data.parentCampaigns.id

string

required

data.parentCampaigns.name

string

required

data.subcampaigns

object[]

List of subcampaigns if the campaign is a parent campaign

Show child attributes

data.subcampaigns.id

string

required

data.subcampaigns.name

string

required

data.applyToAllCampaigns

boolean

Whether the subcampaign is applied to all campaigns

data.totalContributionCount

number

default:0

Total number of contributions towards this campaign

Example:

100

data.totalContributionValue

number

default:0

Total value of contributions towards this campaign

Example:

1000

data.uniqueDonorCount

number

default:0

Total number of unique donors who have donated to this campaign

Example:

100

Get Campaigns Health

⌘I

Start Here

Contributions

Donors

Subscriptions

Payment Methods

Campaigns

Status

Get Campaign/Subcampaign

Authorizations

Path Parameters

Response