Find Campaign

curl --request GET \
  --url https://api.crowdchange.dev/v2/client/fundraisers/search \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.crowdchange.dev/v2/client/fundraisers/search"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.crowdchange.dev/v2/client/fundraisers/search', 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/client/fundraisers/search",
  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/client/fundraisers/search"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.crowdchange.dev/v2/client/fundraisers/search")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.crowdchange.dev/v2/client/fundraisers/search")

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,
    "name": "Campaign",
    "amount_goal": 1000,
    "amount_goal_formatted": "$1,000",
    "amount_raised": 550,
    "amount_raised_formatted": "$550",
    "n_donors": 10,
    "n_teams": 5,
    "n_pages": 15,
    "url": "https://demo.crowdchange.dev/2",
    "language": "en",
    "is_hidden": false,
    "closed_at": "2022-03-01 00:00:00",
    "user": {
      "name": "John Snow",
      "first_name": "John",
      "last_name": "Snow",
      "title": "Mr."
    },
    "organization": {
      "id": 1,
      "name": "Crowdchange",
      "custom_id": "CrowdchangeID"
    },
    "images": {
      "original": "https://img.crowdchange.dev/files/abc.png"
    }
  }
]

GET

client

fundraisers

Find Campaign

curl --request GET \
  --url https://api.crowdchange.dev/v2/client/fundraisers/search \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.crowdchange.dev/v2/client/fundraisers/search"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.crowdchange.dev/v2/client/fundraisers/search', 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/client/fundraisers/search",
  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/client/fundraisers/search"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.crowdchange.dev/v2/client/fundraisers/search")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.crowdchange.dev/v2/client/fundraisers/search")

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,
    "name": "Campaign",
    "amount_goal": 1000,
    "amount_goal_formatted": "$1,000",
    "amount_raised": 550,
    "amount_raised_formatted": "$550",
    "n_donors": 10,
    "n_teams": 5,
    "n_pages": 15,
    "url": "https://demo.crowdchange.dev/2",
    "language": "en",
    "is_hidden": false,
    "closed_at": "2022-03-01 00:00:00",
    "user": {
      "name": "John Snow",
      "first_name": "John",
      "last_name": "Snow",
      "title": "Mr."
    },
    "organization": {
      "id": 1,
      "name": "Crowdchange",
      "custom_id": "CrowdchangeID"
    },
    "images": {
      "original": "https://img.crowdchange.dev/files/abc.png"
    }
  }
]

Query parameters

string

Search term.

string

Comma separated list of fundraiser ids.

string

Comma separated list of fundraiser template (blueprint) ids.

integer

Page number. Default: 1

integer

Number of results to return. Default: 10

string

Key to sort by. Allowed values: name, amount_raised, amount_goal

string

Direction of sorting. Allowed values: asc, desc

string

API’s locale. Allowed values: en, fr

integer

Include closed campaigns. Default: 0

integer

Include hidden campaigns. Default: 0

integer

Include data from subsites. Default: 0

object

Campaign’s amount raised filter.

Response

Returns an array of objects with the following fields.

integer

Campaign ID.

string

Campaign name.

number

Goal amount.

string

Formatted goal amount of the campaign, includes currency symbol.

number

Amount raised by the campaign.

string

Formatted amount raised by the campaign, includes currency symbol.

number

Number of donors

number

Number of teams in the campaign.

number

Number of personal pages in the campaign.

string

URL to campaign.

string

Campaign language. Allowed values: en, fr

boolean

True if campaign is hidden, otherwise false.

string

Campaign closed at

object

Show properties

string

Campaign owner’s name

string

Campaign owner’s first name

string

Campaign owner’s last name

string

Campaign owner’s title

object

Show properties

integer

Campaign organization’s ID

string

Campaign organization’s name

string

Campaign organization’s Custom ID

object

Show properties

string

URL to original campaign’s image.

Other responses

Status	Description
`400`	Bad Request
`403`	Forbidden

[
  {
    "id": 1,
    "name": "Campaign",
    "amount_goal": 1000,
    "amount_goal_formatted": "$1,000",
    "amount_raised": 550,
    "amount_raised_formatted": "$550",
    "n_donors": 10,
    "n_teams": 5,
    "n_pages": 15,
    "url": "https://demo.crowdchange.dev/2",
    "language": "en",
    "is_hidden": false,
    "closed_at": "2022-03-01 00:00:00",
    "user": {
      "name": "John Snow",
      "first_name": "John",
      "last_name": "Snow",
      "title": "Mr."
    },
    "organization": {
      "id": 1,
      "name": "Crowdchange",
      "custom_id": "CrowdchangeID"
    },
    "images": {
      "original": "https://img.crowdchange.dev/files/abc.png"
    }
  }
]

Page Donors List

Find Team

Introduction

Server Side APIs

Client Side APIs

Find Campaign

Query parameters

Response

​Query parameters

​Response

Query parameters

Response