Get Campaign

curl --request GET \
  --url https://api.crowdchange.dev/v2/private/fundraiser/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.crowdchange.dev/v2/private/fundraiser/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.crowdchange.dev/v2/private/fundraiser/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.crowdchange.dev/v2/private/fundraiser/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.crowdchange.dev/v2/private/fundraiser/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "partner_id": 10,
  "name": "Campaign",
  "description": "Description",
  "created_at": "2022-01-01 16:00:03",
  "amount_goal": 1000,
  "amount_goal_formatted": "$1,000",
  "amount_raised": 550,
  "amount_raised_formatted": "$550",
  "goal_type": "amount",
  "amount_pledged": 125,
  "amount_matched": 50,
  "url": "https://demo.crowdchange.dev/2",
  "n_donors": 100,
  "n_teams": 5,
  "n_pages": 20,
  "images": {
    "original": "https://img.crowdchange.co/files/campaign.png"
  },
  "image": "campaign-image-id",
  "language": "en",
  "user": {
    "id": 1,
    "name": "John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "title": "Mr.",
    "email": "john@crowdchange.co",
    "contact_email": "john@crowdchange.co"
  },
  "organization": {
    "id": 1,
    "name": "Crowdchange",
    "custom_id": "CrowdchangeID"
  },
  "closed_at": null,
  "is_hidden": false,
  "fundraiser_template": {
    "id": 1,
    "name": "Template"
  },
  "start_at": "2022-01-01 16:00:03",
  "end_at": "2022-01-02 16:00:03",
  "tags_list": [
    "tag1",
    "tag2"
  ],
  "custom_data": [
    {
      "field_id": 1001,
      "source_id": 11,
      "name": "Phone Number",
      "content": "555-123-4567",
      "field_custom_id": "ABC-123",
      "response_custom_id": null
    }
  ]
}

GET

private

fundraiser

{id}

Get Campaign

curl --request GET \
  --url https://api.crowdchange.dev/v2/private/fundraiser/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.crowdchange.dev/v2/private/fundraiser/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.crowdchange.dev/v2/private/fundraiser/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.crowdchange.dev/v2/private/fundraiser/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.crowdchange.dev/v2/private/fundraiser/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "partner_id": 10,
  "name": "Campaign",
  "description": "Description",
  "created_at": "2022-01-01 16:00:03",
  "amount_goal": 1000,
  "amount_goal_formatted": "$1,000",
  "amount_raised": 550,
  "amount_raised_formatted": "$550",
  "goal_type": "amount",
  "amount_pledged": 125,
  "amount_matched": 50,
  "url": "https://demo.crowdchange.dev/2",
  "n_donors": 100,
  "n_teams": 5,
  "n_pages": 20,
  "images": {
    "original": "https://img.crowdchange.co/files/campaign.png"
  },
  "image": "campaign-image-id",
  "language": "en",
  "user": {
    "id": 1,
    "name": "John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "title": "Mr.",
    "email": "john@crowdchange.co",
    "contact_email": "john@crowdchange.co"
  },
  "organization": {
    "id": 1,
    "name": "Crowdchange",
    "custom_id": "CrowdchangeID"
  },
  "closed_at": null,
  "is_hidden": false,
  "fundraiser_template": {
    "id": 1,
    "name": "Template"
  },
  "start_at": "2022-01-01 16:00:03",
  "end_at": "2022-01-02 16:00:03",
  "tags_list": [
    "tag1",
    "tag2"
  ],
  "custom_data": [
    {
      "field_id": 1001,
      "source_id": 11,
      "name": "Phone Number",
      "content": "555-123-4567",
      "field_custom_id": "ABC-123",
      "response_custom_id": null
    }
  ]
}

Path parameters

integer

required

Fundraiser ID.

Response

integer

Campaign ID.

integer

Site ID.

string

Campaign name.

string | null

Campaign description.

string | null

Full URL to the campaign.

number

Goal amount.

string

Formatted goal amount, including the currency symbol.

number

Amount raised by the campaign.

string

Formatted amount raised by the campaign, including the currency symbol.

string

Campaign goal type.

number

Pending offline donation amount attributed to the campaign.

number

Amount contributed by donation matching assigned directly to the campaign.

integer

Number of donors.

integer

Number of teams in the campaign.

integer

Number of personal pages in the campaign.

object

Show properties

string

URL to the original campaign image.

string | null

Campaign image ID.

string | null

Campaign start date and time.

string | null

Campaign end date and time.

string

Campaign language. Allowed values: en, fr.

any[]

Campaign tags.

object[]

Custom questions and responses configured for the resource.

Show properties

integer

Custom field ID.

integer | null

Source field ID when the field was copied from a Blueprint.

string

Custom field label.

string | null

Formatted response to the custom field.

string | null

Custom ID for the field.

string | null

Custom ID for the selected response, when applicable.

string | null

Campaign creation date and time.

object

Campaign owner.

Show properties

integer

User ID.

string

User name.

string

User email.

string

User contact email.

string

User first name.

string

User last name.

string

User title.

object | null

Campaign organization, when applicable.

Show properties

integer

Organization ID.

string

Organization name.

string

Organization custom ID.

string | null

Campaign close date and time.

boolean

Whether the campaign is hidden.

object | null

Campaign template summary, when applicable.

Show properties

integer

Template ID.

string

Template name.

Other responses

Status	Description
`400`	Bad Request
`401`	Unauthorized
`403`	Forbidden

{
  "id": 1,
  "partner_id": 10,
  "name": "Campaign",
  "description": "Description",
  "created_at": "2022-01-01 16:00:03",
  "amount_goal": 1000,
  "amount_goal_formatted": "$1,000",
  "amount_raised": 550,
  "amount_raised_formatted": "$550",
  "goal_type": "amount",
  "amount_pledged": 125,
  "amount_matched": 50,
  "url": "https://demo.crowdchange.dev/2",
  "n_donors": 100,
  "n_teams": 5,
  "n_pages": 20,
  "images": {
    "original": "https://img.crowdchange.co/files/campaign.png"
  },
  "image": "campaign-image-id",
  "language": "en",
  "user": {
    "id": 1,
    "name": "John Snow",
    "first_name": "John",
    "last_name": "Snow",
    "title": "Mr.",
    "email": "john@crowdchange.co",
    "contact_email": "john@crowdchange.co"
  },
  "organization": {
    "id": 1,
    "name": "Crowdchange",
    "custom_id": "CrowdchangeID"
  },
  "closed_at": null,
  "is_hidden": false,
  "fundraiser_template": {
    "id": 1,
    "name": "Template"
  },
  "start_at": "2022-01-01 16:00:03",
  "end_at": "2022-01-02 16:00:03",
  "tags_list": [
    "tag1",
    "tag2"
  ],
  "custom_data": [
    {
      "field_id": 1001,
      "source_id": 11,
      "name": "Phone Number",
      "content": "555-123-4567",
      "field_custom_id": "ABC-123",
      "response_custom_id": null
    }
  ]
}

Last modified on August 17, 2026

Introduction

Server Side APIs

Client Side APIs

Get Campaign

Path parameters

Response

​Path parameters

​Response

Path parameters

Response