Find Personal Page

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

Find Personal Page

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

Query parameters

string

Search term.

integer

Team id. Returns specific team if provided.

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 personal pages from hidden campaigns. Default: 0

integer

Include data from subsites. Default: 0

boolean

Include the personal page description in the response. The returned description is plain text with all HTML removed and truncated to 200 characters. Default: false

object

Personal page’s amount raised filter.

Response

Returns an array of objects with the following fields.

integer

Personal page ID.

string

Personal page name.

string

Personal page description as plain text with all HTML removed, truncated to 200 characters. Only returned when include_description is set.

string

Personal page image ID

number

Goal amount.

string

Formatted goal amount of the personal page, includes currency symbol.

number

Amount raised by the personal page.

string

Formatted amount raised by the personal page, includes currency symbol.

number

Number of donors

string

Full URL to personal page.

string

Personal page language. Allowed values: en, fr

object

Team name that personal page belongs to (if assigned to a team).

Show properties

integer

Team ID.

string

Team name.

number

Team’s goal amount.

number

Total amount raised by the team.

string

Formatted amount raised by the team, includes currency symbol.

string

Full URL to team’s page.

string

Team language. Allowed values: en, fr

object

Campaign that personal page belongs to.

Show properties

integer

Campaign ID.

string

Campaign name.

number

Campaign’s goal amount.

number

Total amount raised by the campaign.

string

Formatted amount raised by the campaign, includes currency symbol.

string

URL to campaign’s page.

string

Campaign language. Allowed values: en, fr

object

Show properties

integer

Campaign organization’s ID

string

Campaign organization’s name

string

Campaign organization’s Custom ID

object

Show properties

string

Personal page owner’s name

string

Personal page owner’s first name

string

Personal page owner’s last name

string

Personal page owner’s title

Other responses

Status	Description
`400`	Bad Request
`403`	Forbidden

[
  {
    "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 Team

Get Personal Page

Introduction

Server Side APIs

Client Side APIs

Find Personal Page

Query parameters

Response

​Query parameters

​Response

Query parameters

Response