Rechercher une campagne
curl --request POST \
--url https://api.crowdchange.dev/v2/private/fundraisers/search \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "<string>",
"page": 123,
"limit": 123,
"sort": "<string>",
"direction": "<string>",
"email": "<string>",
"status": "<string>",
"is_hidden": true,
"created_at": {
"<": "<string>",
"<=": "<string>",
"=": "<string>",
">=": "<string>",
">": "<string>"
},
"amount_goal": {
"<": 123,
"<=": 123,
"=": 123,
">=": 123,
">": 123
},
"amount_raised": {
"<": 123,
"<=": 123,
"=": 123,
">=": 123,
">": 123
},
"after_id": 123,
"lang": "<string>",
"filter_by_lang": 123,
"tags": [
"<string>"
]
}
'import requests
url = "https://api.crowdchange.dev/v2/private/fundraisers/search"
payload = {
"text": "<string>",
"page": 123,
"limit": 123,
"sort": "<string>",
"direction": "<string>",
"email": "<string>",
"status": "<string>",
"is_hidden": True,
"created_at": {
"<": "<string>",
"<=": "<string>",
"=": "<string>",
">=": "<string>",
">": "<string>"
},
"amount_goal": {
"<": 123,
"<=": 123,
"=": 123,
">=": 123,
">": 123
},
"amount_raised": {
"<": 123,
"<=": 123,
"=": 123,
">=": 123,
">": 123
},
"after_id": 123,
"lang": "<string>",
"filter_by_lang": 123,
"tags": ["<string>"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
text: '<string>',
page: 123,
limit: 123,
sort: '<string>',
direction: '<string>',
email: '<string>',
status: '<string>',
is_hidden: true,
created_at: {
'<': '<string>',
'<=': '<string>',
'=': '<string>',
'>=': '<string>',
'>': '<string>'
},
amount_goal: {'<': 123, '<=': 123, '=': 123, '>=': 123, '>': 123},
amount_raised: {'<': 123, '<=': 123, '=': 123, '>=': 123, '>': 123},
after_id: 123,
lang: '<string>',
filter_by_lang: 123,
tags: ['<string>']
})
};
fetch('https://api.crowdchange.dev/v2/private/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/private/fundraisers/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'text' => '<string>',
'page' => 123,
'limit' => 123,
'sort' => '<string>',
'direction' => '<string>',
'email' => '<string>',
'status' => '<string>',
'is_hidden' => true,
'created_at' => [
'<' => '<string>',
'<=' => '<string>',
'=' => '<string>',
'>=' => '<string>',
'>' => '<string>'
],
'amount_goal' => [
'<' => 123,
'<=' => 123,
'=' => 123,
'>=' => 123,
'>' => 123
],
'amount_raised' => [
'<' => 123,
'<=' => 123,
'=' => 123,
'>=' => 123,
'>' => 123
],
'after_id' => 123,
'lang' => '<string>',
'filter_by_lang' => 123,
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.crowdchange.dev/v2/private/fundraisers/search"
payload := strings.NewReader("{\n \"text\": \"<string>\",\n \"page\": 123,\n \"limit\": 123,\n \"sort\": \"<string>\",\n \"direction\": \"<string>\",\n \"email\": \"<string>\",\n \"status\": \"<string>\",\n \"is_hidden\": true,\n \"created_at\": {\n \"<\": \"<string>\",\n \"<=\": \"<string>\",\n \"=\": \"<string>\",\n \">=\": \"<string>\",\n \">\": \"<string>\"\n },\n \"amount_goal\": {\n \"<\": 123,\n \"<=\": 123,\n \"=\": 123,\n \">=\": 123,\n \">\": 123\n },\n \"amount_raised\": {\n \"<\": 123,\n \"<=\": 123,\n \"=\": 123,\n \">=\": 123,\n \">\": 123\n },\n \"after_id\": 123,\n \"lang\": \"<string>\",\n \"filter_by_lang\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.crowdchange.dev/v2/private/fundraisers/search")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"<string>\",\n \"page\": 123,\n \"limit\": 123,\n \"sort\": \"<string>\",\n \"direction\": \"<string>\",\n \"email\": \"<string>\",\n \"status\": \"<string>\",\n \"is_hidden\": true,\n \"created_at\": {\n \"<\": \"<string>\",\n \"<=\": \"<string>\",\n \"=\": \"<string>\",\n \">=\": \"<string>\",\n \">\": \"<string>\"\n },\n \"amount_goal\": {\n \"<\": 123,\n \"<=\": 123,\n \"=\": 123,\n \">=\": 123,\n \">\": 123\n },\n \"amount_raised\": {\n \"<\": 123,\n \"<=\": 123,\n \"=\": 123,\n \">=\": 123,\n \">\": 123\n },\n \"after_id\": 123,\n \"lang\": \"<string>\",\n \"filter_by_lang\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.crowdchange.dev/v2/private/fundraisers/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"<string>\",\n \"page\": 123,\n \"limit\": 123,\n \"sort\": \"<string>\",\n \"direction\": \"<string>\",\n \"email\": \"<string>\",\n \"status\": \"<string>\",\n \"is_hidden\": true,\n \"created_at\": {\n \"<\": \"<string>\",\n \"<=\": \"<string>\",\n \"=\": \"<string>\",\n \">=\": \"<string>\",\n \">\": \"<string>\"\n },\n \"amount_goal\": {\n \"<\": 123,\n \"<=\": 123,\n \"=\": 123,\n \">=\": 123,\n \">\": 123\n },\n \"amount_raised\": {\n \"<\": 123,\n \"<=\": 123,\n \"=\": 123,\n \">=\": 123,\n \">\": 123\n },\n \"after_id\": 123,\n \"lang\": \"<string>\",\n \"filter_by_lang\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": 1,
"partner_id": 10,
"name": "Campaign",
"created_at": "2022-01-01 16:00:03",
"amount_goal": 1000,
"amount_raised": 550,
"amount_raised_formatted": "$550",
"dt_start": "2021-01-01 08:00:00",
"dt_end": "2021-01-01 16:00:00",
"location": "100 Main Street, Toronto, ON",
"url": "https://demo.crowdchange.dev/2",
"n_donors": 100,
"n_teams": 50,
"n_pages": 50,
"status": "approved",
"status_code": "approved",
"is_hidden": false,
"auto_open_at": "2022-03-01 00:00:00",
"auto_close_at": "2022-03-01 00:00:00",
"closed_at": "2022-03-01 00:00:00",
"archived_at": "2022-03-01 00:00:00",
"language": "en",
"in_support_name": "Cancer Research",
"in_support_code": "CR-123",
"appeal_code": "GEN-123",
"user": {
"id": 1,
"name": "John Snow",
"first_name": "John",
"last_name": "Snow",
"title": "Mr.",
"email": "john@crowdchange.co"
},
"organization": {
"id": 1,
"name": "Crowdchange",
"custom_id": "CrowdchangeID"
},
"fundraiser_template": {
"id": 1,
"name": "Template"
},
"images": {
"original": "https://img.crowdchange.co/files/abc.png?tr=w-[width],h-[height]"
},
"custom_data": [
{
"field_id": 1001,
"source_id": 11,
"name": "Phone Number",
"content": "555-123-4567",
"field_custom_id": "ABC-123",
"response_custom_id": "ABC-123"
}
],
"tags_list": [
"tag1",
"tag2"
]
}
]
API globales
Rechercher une campagne
Recherchez des campagnes CrowdChange côté serveur avec des filtres avancés et récupérez une liste paginée avec objectif, montant amassé et statut.
POST
/
v2
/
private
/
fundraisers
/
search
Rechercher une campagne
curl --request POST \
--url https://api.crowdchange.dev/v2/private/fundraisers/search \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "<string>",
"page": 123,
"limit": 123,
"sort": "<string>",
"direction": "<string>",
"email": "<string>",
"status": "<string>",
"is_hidden": true,
"created_at": {
"<": "<string>",
"<=": "<string>",
"=": "<string>",
">=": "<string>",
">": "<string>"
},
"amount_goal": {
"<": 123,
"<=": 123,
"=": 123,
">=": 123,
">": 123
},
"amount_raised": {
"<": 123,
"<=": 123,
"=": 123,
">=": 123,
">": 123
},
"after_id": 123,
"lang": "<string>",
"filter_by_lang": 123,
"tags": [
"<string>"
]
}
'import requests
url = "https://api.crowdchange.dev/v2/private/fundraisers/search"
payload = {
"text": "<string>",
"page": 123,
"limit": 123,
"sort": "<string>",
"direction": "<string>",
"email": "<string>",
"status": "<string>",
"is_hidden": True,
"created_at": {
"<": "<string>",
"<=": "<string>",
"=": "<string>",
">=": "<string>",
">": "<string>"
},
"amount_goal": {
"<": 123,
"<=": 123,
"=": 123,
">=": 123,
">": 123
},
"amount_raised": {
"<": 123,
"<=": 123,
"=": 123,
">=": 123,
">": 123
},
"after_id": 123,
"lang": "<string>",
"filter_by_lang": 123,
"tags": ["<string>"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
text: '<string>',
page: 123,
limit: 123,
sort: '<string>',
direction: '<string>',
email: '<string>',
status: '<string>',
is_hidden: true,
created_at: {
'<': '<string>',
'<=': '<string>',
'=': '<string>',
'>=': '<string>',
'>': '<string>'
},
amount_goal: {'<': 123, '<=': 123, '=': 123, '>=': 123, '>': 123},
amount_raised: {'<': 123, '<=': 123, '=': 123, '>=': 123, '>': 123},
after_id: 123,
lang: '<string>',
filter_by_lang: 123,
tags: ['<string>']
})
};
fetch('https://api.crowdchange.dev/v2/private/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/private/fundraisers/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'text' => '<string>',
'page' => 123,
'limit' => 123,
'sort' => '<string>',
'direction' => '<string>',
'email' => '<string>',
'status' => '<string>',
'is_hidden' => true,
'created_at' => [
'<' => '<string>',
'<=' => '<string>',
'=' => '<string>',
'>=' => '<string>',
'>' => '<string>'
],
'amount_goal' => [
'<' => 123,
'<=' => 123,
'=' => 123,
'>=' => 123,
'>' => 123
],
'amount_raised' => [
'<' => 123,
'<=' => 123,
'=' => 123,
'>=' => 123,
'>' => 123
],
'after_id' => 123,
'lang' => '<string>',
'filter_by_lang' => 123,
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.crowdchange.dev/v2/private/fundraisers/search"
payload := strings.NewReader("{\n \"text\": \"<string>\",\n \"page\": 123,\n \"limit\": 123,\n \"sort\": \"<string>\",\n \"direction\": \"<string>\",\n \"email\": \"<string>\",\n \"status\": \"<string>\",\n \"is_hidden\": true,\n \"created_at\": {\n \"<\": \"<string>\",\n \"<=\": \"<string>\",\n \"=\": \"<string>\",\n \">=\": \"<string>\",\n \">\": \"<string>\"\n },\n \"amount_goal\": {\n \"<\": 123,\n \"<=\": 123,\n \"=\": 123,\n \">=\": 123,\n \">\": 123\n },\n \"amount_raised\": {\n \"<\": 123,\n \"<=\": 123,\n \"=\": 123,\n \">=\": 123,\n \">\": 123\n },\n \"after_id\": 123,\n \"lang\": \"<string>\",\n \"filter_by_lang\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.crowdchange.dev/v2/private/fundraisers/search")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"<string>\",\n \"page\": 123,\n \"limit\": 123,\n \"sort\": \"<string>\",\n \"direction\": \"<string>\",\n \"email\": \"<string>\",\n \"status\": \"<string>\",\n \"is_hidden\": true,\n \"created_at\": {\n \"<\": \"<string>\",\n \"<=\": \"<string>\",\n \"=\": \"<string>\",\n \">=\": \"<string>\",\n \">\": \"<string>\"\n },\n \"amount_goal\": {\n \"<\": 123,\n \"<=\": 123,\n \"=\": 123,\n \">=\": 123,\n \">\": 123\n },\n \"amount_raised\": {\n \"<\": 123,\n \"<=\": 123,\n \"=\": 123,\n \">=\": 123,\n \">\": 123\n },\n \"after_id\": 123,\n \"lang\": \"<string>\",\n \"filter_by_lang\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.crowdchange.dev/v2/private/fundraisers/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"<string>\",\n \"page\": 123,\n \"limit\": 123,\n \"sort\": \"<string>\",\n \"direction\": \"<string>\",\n \"email\": \"<string>\",\n \"status\": \"<string>\",\n \"is_hidden\": true,\n \"created_at\": {\n \"<\": \"<string>\",\n \"<=\": \"<string>\",\n \"=\": \"<string>\",\n \">=\": \"<string>\",\n \">\": \"<string>\"\n },\n \"amount_goal\": {\n \"<\": 123,\n \"<=\": 123,\n \"=\": 123,\n \">=\": 123,\n \">\": 123\n },\n \"amount_raised\": {\n \"<\": 123,\n \"<=\": 123,\n \"=\": 123,\n \">=\": 123,\n \">\": 123\n },\n \"after_id\": 123,\n \"lang\": \"<string>\",\n \"filter_by_lang\": 123,\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"id": 1,
"partner_id": 10,
"name": "Campaign",
"created_at": "2022-01-01 16:00:03",
"amount_goal": 1000,
"amount_raised": 550,
"amount_raised_formatted": "$550",
"dt_start": "2021-01-01 08:00:00",
"dt_end": "2021-01-01 16:00:00",
"location": "100 Main Street, Toronto, ON",
"url": "https://demo.crowdchange.dev/2",
"n_donors": 100,
"n_teams": 50,
"n_pages": 50,
"status": "approved",
"status_code": "approved",
"is_hidden": false,
"auto_open_at": "2022-03-01 00:00:00",
"auto_close_at": "2022-03-01 00:00:00",
"closed_at": "2022-03-01 00:00:00",
"archived_at": "2022-03-01 00:00:00",
"language": "en",
"in_support_name": "Cancer Research",
"in_support_code": "CR-123",
"appeal_code": "GEN-123",
"user": {
"id": 1,
"name": "John Snow",
"first_name": "John",
"last_name": "Snow",
"title": "Mr.",
"email": "john@crowdchange.co"
},
"organization": {
"id": 1,
"name": "Crowdchange",
"custom_id": "CrowdchangeID"
},
"fundraiser_template": {
"id": 1,
"name": "Template"
},
"images": {
"original": "https://img.crowdchange.co/files/abc.png?tr=w-[width],h-[height]"
},
"custom_data": [
{
"field_id": 1001,
"source_id": 11,
"name": "Phone Number",
"content": "555-123-4567",
"field_custom_id": "ABC-123",
"response_custom_id": "ABC-123"
}
],
"tags_list": [
"tag1",
"tag2"
]
}
]
Paramètres du corps
string
Terme de recherche.
integer
Numéro de page. Par défaut :
1integer
Nombre de résultats à retourner. Par défaut :
100string
Clé de tri. Valeurs permises :
id, name, amount_raised, amount_goalstring
Sens du tri. Valeurs permises :
asc, descstring
Filtre par courriel.
string
Statut de la campagne. Valeurs permises :
approved, pendingboolean
Vrai si la campagne est masquée, sinon faux.
object
object
object
integer
Retourne les équipes après cet identifiant d’équipe.
string
Langue de l’API. Valeurs permises :
en, frinteger
Filtre les campagnes disponibles uniquement dans cette langue
string[]
Liste des étiquettes de la campagne.
Réponse
Retourne un tableau d’objets contenant les champs suivants.integer
Identifiant de la campagne.
integer
Identifiant du site.
string
Nom de la campagne.
string
Date de création de la campagne.
number
Montant de l’objectif.
number
Montant amassé par la campagne.
string
Montant amassé par la campagne, formaté avec le symbole de devise.
string
Date et heure de début de la campagne.
string
Date et heure de fin de la campagne.
string
Lieu de la campagne.
string
URL de la campagne.
integer
Nombre de donateurs.
integer
Nombre d’équipes.
integer
Nombre de pages.
string
Statut d’approbation de la campagne. Valeurs permises :
approved, pendingstring
Code de statut d’activité de la campagne. Valeurs permises :
live, deleted, archived, pending_approval, opening_soon, closedboolean
Vrai si la campagne est masquée, sinon faux.
string
Date à laquelle la campagne est programmée pour s’ouvrir automatiquement
string
Date à laquelle la campagne est programmée pour se fermer automatiquement
string
Date à laquelle la campagne a été fermée
string
Date à laquelle la campagne a été archivée
string
Langue de la campagne. Valeurs permises :
en, frstring
Valeur du champ
In support of (« au profit de ») associé à la campagne.string
Code fourni pour le champ
In support of (« au profit de »).string
Code d’appel.
object
object
object[]
Liste des questions personnalisées et de leurs réponses.
Afficher propriétés
Afficher propriétés
integer
Identifiant du champ personnalisé.
integer
Si le champ a été copié depuis un Blueprint, ceci référence l’identifiant du champ source dans le Blueprint (similaire à un identifiant de groupe).
string
Libellé du champ personnalisé.
string
Réponse de l’utilisateur au champ personnalisé.
string
Identifiant personnalisé.
string
Identifiant personnalisé pour la réponse (questions à choix multiples).
any[]
Étiquettes de la campagne.
| Statut | Description |
|---|---|
400 | Requête invalide |
403 | Interdit |
[
{
"id": 1,
"partner_id": 10,
"name": "Campaign",
"created_at": "2022-01-01 16:00:03",
"amount_goal": 1000,
"amount_raised": 550,
"amount_raised_formatted": "$550",
"dt_start": "2021-01-01 08:00:00",
"dt_end": "2021-01-01 16:00:00",
"location": "100 Main Street, Toronto, ON",
"url": "https://demo.crowdchange.dev/2",
"n_donors": 100,
"n_teams": 50,
"n_pages": 50,
"status": "approved",
"status_code": "approved",
"is_hidden": false,
"auto_open_at": "2022-03-01 00:00:00",
"auto_close_at": "2022-03-01 00:00:00",
"closed_at": "2022-03-01 00:00:00",
"archived_at": "2022-03-01 00:00:00",
"language": "en",
"in_support_name": "Cancer Research",
"in_support_code": "CR-123",
"appeal_code": "GEN-123",
"user": {
"id": 1,
"name": "John Snow",
"first_name": "John",
"last_name": "Snow",
"title": "Mr.",
"email": "john@crowdchange.co"
},
"organization": {
"id": 1,
"name": "Crowdchange",
"custom_id": "CrowdchangeID"
},
"fundraiser_template": {
"id": 1,
"name": "Template"
},
"images": {
"original": "https://img.crowdchange.co/files/abc.png?tr=w-[width],h-[height]"
},
"custom_data": [
{
"field_id": 1001,
"source_id": 11,
"name": "Phone Number",
"content": "555-123-4567",
"field_custom_id": "ABC-123",
"response_custom_id": "ABC-123"
}
],
"tags_list": [
"tag1",
"tag2"
]
}
]
Cette page vous a-t-elle été utile ?
⌘I