Rechercher une page personnelle

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

import requests

url = "https://api.crowdchange.dev/v2/client/personal-pages/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/personal-pages/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/personal-pages/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/personal-pages/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/personal-pages/search")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.crowdchange.dev/v2/client/personal-pages/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": "John Snow",
    "description": "Help us reach our goal and make a difference!",
    "image": "1eaf5ab2-5d55-11ee-82ef-001c42584fa2",
    "amount_goal": 1000,
    "amount_goal_formatted": "$1,000",
    "amount_raised": 550,
    "amount_raised_formatted": "$550",
    "n_donors": 10,
    "url": "https://demo.crowdchange.dev/2/page/1",
    "language": "en",
    "team": {
      "id": 1,
      "name": "Gala Night",
      "amount_goal": 10000,
      "amount_raised": 8000,
      "amount_raised_formatted": "$8,000",
      "url": "https://demo.crowdchange.dev/1/team/2",
      "language": "en"
    },
    "fundraiser": {
      "id": 1,
      "name": "Gala Night",
      "amount_goal": 10000,
      "amount_raised": 8000,
      "amount_raised_formatted": "$8,000",
      "url": "https://demo.crowdchange.dev/1",
      "language": "en",
      "organization": {
        "id": 1,
        "name": "Crowdchange",
        "custom_id": "CrowdchangeID"
      }
    },
    "user": {
      "name": "John Snow",
      "first_name": "John",
      "last_name": "Snow",
      "title": "Mr."
    }
  }
]

GET

client

personal-pages

Rechercher une page personnelle

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

import requests

url = "https://api.crowdchange.dev/v2/client/personal-pages/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/personal-pages/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/personal-pages/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/personal-pages/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/personal-pages/search")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.crowdchange.dev/v2/client/personal-pages/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": "John Snow",
    "description": "Help us reach our goal and make a difference!",
    "image": "1eaf5ab2-5d55-11ee-82ef-001c42584fa2",
    "amount_goal": 1000,
    "amount_goal_formatted": "$1,000",
    "amount_raised": 550,
    "amount_raised_formatted": "$550",
    "n_donors": 10,
    "url": "https://demo.crowdchange.dev/2/page/1",
    "language": "en",
    "team": {
      "id": 1,
      "name": "Gala Night",
      "amount_goal": 10000,
      "amount_raised": 8000,
      "amount_raised_formatted": "$8,000",
      "url": "https://demo.crowdchange.dev/1/team/2",
      "language": "en"
    },
    "fundraiser": {
      "id": 1,
      "name": "Gala Night",
      "amount_goal": 10000,
      "amount_raised": 8000,
      "amount_raised_formatted": "$8,000",
      "url": "https://demo.crowdchange.dev/1",
      "language": "en",
      "organization": {
        "id": 1,
        "name": "Crowdchange",
        "custom_id": "CrowdchangeID"
      }
    },
    "user": {
      "name": "John Snow",
      "first_name": "John",
      "last_name": "Snow",
      "title": "Mr."
    }
  }
]

Paramètres de requête

string

Terme de recherche.

integer

ID de l’équipe. Retourne l’équipe spécifique si fourni.

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 pages personnelles des campagnes masquées. Par défaut : 0

integer

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

boolean

Inclure la description de la page personnelle dans la réponse. La description retournée est en texte brut, sans HTML, et tronquée à 200 caractères. Par défaut : false

object

Filtre sur le montant amassé de la page personnelle.

Réponse

Retourne un tableau d’objets contenant les champs suivants.

integer

ID de la page personnelle.

string

Nom de la page personnelle.

string

Description de la page personnelle en texte brut, sans HTML, tronquée à 200 caractères. Retournée uniquement lorsque include_description est défini.

string

ID de l’image de la page personnelle.

number

Montant de l’objectif.

string

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

number

Montant amassé par la page personnelle.

string

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

number

Nombre de donateurs.

string

URL complète de la page personnelle.

string

Langue de la page personnelle. Valeurs permises : en, fr

object

Nom de l’équipe à laquelle la page personnelle appartient (si elle est associée à une équipe).

Afficher propriétés

integer

ID de l’équipe.

string

Nom de l’équipe.

number

Montant de l’objectif de l’équipe.

number

Montant total amassé par l’équipe.

string

Montant formaté amassé par l’équipe, incluant le symbole de devise.

string

URL complète de la page de l’équipe.

string

Langue de l’équipe. Valeurs permises : en, fr

object

Campagne à laquelle la page personnelle appartient.

Afficher propriétés

integer

ID de la campagne.

string

Nom de la campagne.

number

Montant de l’objectif de la campagne.

number

Montant total amassé par la campagne.

string

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

string

URL de la page de la campagne.

string

Langue de la campagne. Valeurs permises : en, fr

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

Nom du propriétaire de la page personnelle.

string

Prénom du propriétaire de la page personnelle.

string

Nom de famille du propriétaire de la page personnelle.

string

Titre du propriétaire de la page personnelle.

Autres réponses

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

[
  {
    "id": 1,
    "name": "John Snow",
    "description": "Help us reach our goal and make a difference!",
    "image": "1eaf5ab2-5d55-11ee-82ef-001c42584fa2",
    "amount_goal": 1000,
    "amount_goal_formatted": "$1,000",
    "amount_raised": 550,
    "amount_raised_formatted": "$550",
    "n_donors": 10,
    "url": "https://demo.crowdchange.dev/2/page/1",
    "language": "en",
    "team": {
      "id": 1,
      "name": "Gala Night",
      "amount_goal": 10000,
      "amount_raised": 8000,
      "amount_raised_formatted": "$8,000",
      "url": "https://demo.crowdchange.dev/1/team/2",
      "language": "en"
    },
    "fundraiser": {
      "id": 1,
      "name": "Gala Night",
      "amount_goal": 10000,
      "amount_raised": 8000,
      "amount_raised_formatted": "$8,000",
      "url": "https://demo.crowdchange.dev/1",
      "language": "en",
      "organization": {
        "id": 1,
        "name": "Crowdchange",
        "custom_id": "CrowdchangeID"
      }
    },
    "user": {
      "name": "John Snow",
      "first_name": "John",
      "last_name": "Snow",
      "title": "Mr."
    }
  }
]

Obtenir une équipe

Obtenir une page personnelle

Introduction

API côté serveur

API côté client

Rechercher une page personnelle

Paramètres de requête

Réponse

​Paramètres de requête

​Réponse

Paramètres de requête

Réponse