Rechercher une campagne

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

Rechercher une campagne

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"
    }
  }
]

Paramètres de requête

string

Terme de recherche.

string

Liste d’ID de campagnes séparés par des virgules.

string

Liste d’ID de modèles de campagne séparés par des virgules.

integer

Numéro de page. Par défaut : 1

integer

Nombre de résultats à retourner. Par défaut : 10

string

Clé de tri. Valeurs permises : name, amount_raised, amount_goal

string

Direction du tri. Valeurs permises : asc, desc

string

Langue de l’API. Valeurs permises : en, fr

integer

Inclure les campagnes fermées. Par défaut : 0

integer

Inclure les campagnes masquées. Par défaut : 0

integer

Inclure les données des sous-sites. Par défaut : 0

object

Filtre sur le montant amassé de la campagne.

Réponse

Retourne un tableau d’objets contenant les champs suivants.

integer

ID de la campagne.

string

Nom de la campagne.

number

Montant de l’objectif.

string

Montant formaté de l’objectif de la campagne, incluant le symbole de devise.

number

Montant amassé par la campagne.

string

Montant formaté amassé par la campagne, incluant le symbole de devise.

number

Nombre de donateurs.

number

Nombre d’équipes dans la campagne.

number

Nombre de pages personnelles dans la campagne.

string

URL de la campagne.

string

Langue de la campagne. Valeurs permises : en, fr

boolean

Vrai si la campagne est masquée, faux autrement.

string

Date de fermeture de la campagne.

object

Afficher propriétés

string

Nom du propriétaire de la campagne.

string

Prénom du propriétaire de la campagne.

string

Nom de famille du propriétaire de la campagne.

string

Titre du propriétaire de la campagne.

object

Afficher propriétés

integer

ID de l’organisation de la campagne.

string

Nom de l’organisation de la campagne.

string

ID personnalisé de l’organisation de la campagne.

object

Afficher propriétés

string

URL de l’image originale de la campagne.

Autres réponses

Statut	Description
`400`	Requête invalide
`403`	Interdit

[
  {
    "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"
    }
  }
]

Liste des donateurs d'une page

Rechercher une équipe

Introduction

API côté serveur

API côté client

Rechercher une campagne

Paramètres de requête

Réponse

​Paramètres de requête

​Réponse

Paramètres de requête

Réponse