Skip to main content
GET
/
v2
/
private
/
user
/
teams
Get Teams
curl --request GET \
  --url https://api.crowdchange.dev/v2/private/user/teams \
  --header 'Authorization: <api-key>'
[
  {
    "id": 1,
    "name": "Team A",
    "description": "Team description",
    "image": "1eaf5ab2-5d55-11ee-82ef-001c42584fa2",
    "amount_goal": 1000,
    "amount_raised": 550,
    "amount_raised_formatted": "$550",
    "n_pages": 5,
    "url": "https://demo.crowdchange.dev/1/team/2",
    "language": "en",
    "is_default_image": false,
    "is_default_description": false,
    "images": {
      "original": "https://img.crowdchange.co/files/abc.png?tr=w-[width],h-[height]"
    },
    "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": {
      "id": 1,
      "contact_email": "john@example.com",
      "name": "John Snow",
      "first_name": "John",
      "last_name": "Snow",
      "title": "Mr."
    }
  }
]

​
Query parameters

​
token
string
required
User’s access token.
​
text
string
Search term.
​
page
integer
Page number. Default: 1
​
limit
integer
Number of results to return. Default: 10
​
sort
string
Key to sort by. Allowed values: name, amount_raised, amount_goal
​
direction
string
Direction of sorting. Allowed values: asc, desc
​
lang
string
API’s locale. Allowed values: en, fr

​
Response

Returns an array of objects with the following fields.
​
id
integer
Team ID.
​
name
string
Team name.
​
description
string
Team description
​
image
string
Team image ID
​
amount_goal
number
Goal amount.
​
amount_raised
number
Amount raised by the team.
​
amount_raised_formatted
string
Formatted amount raised by the team, includes currency symbol.
​
n_pages
integer
Number of personal pages in the team.
​
url
string
URL to team’s page.
​
language
string
Team language. Allowed values: en, fr
​
is_default_image
boolean
True if the image is default.
​
is_default_description
boolean
True if the description is default.
​
images
object
​
fundraiser
object
Campaign that team belongs to.
​
user
object
Other responses
StatusDescription
400Bad Request
403Forbidden
[
  {
    "id": 1,
    "name": "Team A",
    "description": "Team description",
    "image": "1eaf5ab2-5d55-11ee-82ef-001c42584fa2",
    "amount_goal": 1000,
    "amount_raised": 550,
    "amount_raised_formatted": "$550",
    "n_pages": 5,
    "url": "https://demo.crowdchange.dev/1/team/2",
    "language": "en",
    "is_default_image": false,
    "is_default_description": false,
    "images": {
      "original": "https://img.crowdchange.co/files/abc.png?tr=w-[width],h-[height]"
    },
    "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": {
      "id": 1,
      "contact_email": "john@example.com",
      "name": "John Snow",
      "first_name": "John",
      "last_name": "Snow",
      "title": "Mr."
    }
  }
]