Passer au contenu principal
GET
/
v2
/
client
/
personal-pages
/
{id}
Get Personal Page
curl --request GET \
  --url https://api.crowdchange.dev/v2/client/personal-pages/{id} \
  --header 'Authorization: <api-key>'
{
  "id": 1,
  "name": "John Snow",
  "description": "Help us reach our goal and make a difference!",
  "images": {
    "original": "https://img.crowdchange.dev/files/abc.png"
  },
  "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."
  }
}

​
Path parameters

​
id
integer
requis
Personal page ID.

​
Query parameters

​
include_description
boolean
Include the full personal page description in the response. Default: false

​
Response

​
id
integer
Personal page ID.
​
name
string
Personal page name.
​
description
string
Full personal page description. May contain HTML. Only returned when include_description is set.
​
images
object
​
amount_goal
number
Goal amount.
​
amount_goal_formatted
string
Formatted goal amount of the personal page, includes currency symbol.
​
amount_raised
number
Amount raised by the personal page.
​
amount_raised_formatted
string
Formatted amount raised by the personal page, includes currency symbol.
​
n_donors
number
Number of donors
​
url
string
Full URL to personal page.
​
language
string
Personal page language. Allowed values: en, fr
​
team
object
Team name that personal page belongs to (if assigned to a team).
​
fundraiser
object
Campaign that personal page belongs to.
​
user
object
Other responses
StatusDescription
400Bad Request
403Forbidden
{
  "id": 1,
  "name": "John Snow",
  "description": "Help us reach our goal and make a difference!",
  "images": {
    "original": "https://img.crowdchange.dev/files/abc.png"
  },
  "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."
  }
}