Find Team

Find Team

curl --request POST \
  --url https://api.crowdchange.dev/v2/private/teams/search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "page": 123,
  "limit": 123,
  "sort": "<string>",
  "direction": "<string>",
  "email": "<string>",
  "created_at": {
    "<": "<string>",
    "<=": "<string>",
    "=": "<string>",
    ">=": "<string>",
    ">": "<string>"
  },
  "amount_goal": {
    "<": 123,
    "<=": 123,
    "=": 123,
    ">=": 123,
    ">": 123
  },
  "amount_raised": {
    "<": 123,
    "<=": 123,
    "=": 123,
    ">=": 123,
    ">": 123
  },
  "fundraiser_id": 123,
  "after_id": 123,
  "lang": "<string>",
  "filter_by_lang": 123,
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://api.crowdchange.dev/v2/private/teams/search"

payload = {
    "text": "<string>",
    "page": 123,
    "limit": 123,
    "sort": "<string>",
    "direction": "<string>",
    "email": "<string>",
    "created_at": {
        "<": "<string>",
        "<=": "<string>",
        "=": "<string>",
        ">=": "<string>",
        ">": "<string>"
    },
    "amount_goal": {
        "<": 123,
        "<=": 123,
        "=": 123,
        ">=": 123,
        ">": 123
    },
    "amount_raised": {
        "<": 123,
        "<=": 123,
        "=": 123,
        ">=": 123,
        ">": 123
    },
    "fundraiser_id": 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>',
    created_at: {
      '<': '<string>',
      '<=': '<string>',
      '=': '<string>',
      '>=': '<string>',
      '>': '<string>'
    },
    amount_goal: {'<': 123, '<=': 123, '=': 123, '>=': 123, '>': 123},
    amount_raised: {'<': 123, '<=': 123, '=': 123, '>=': 123, '>': 123},
    fundraiser_id: 123,
    after_id: 123,
    lang: '<string>',
    filter_by_lang: 123,
    tags: ['<string>']
  })
};

fetch('https://api.crowdchange.dev/v2/private/teams/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/teams/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>',
    'created_at' => [
        '<' => '<string>',
        '<=' => '<string>',
        '=' => '<string>',
        '>=' => '<string>',
        '>' => '<string>'
    ],
    'amount_goal' => [
        '<' => 123,
        '<=' => 123,
        '=' => 123,
        '>=' => 123,
        '>' => 123
    ],
    'amount_raised' => [
        '<' => 123,
        '<=' => 123,
        '=' => 123,
        '>=' => 123,
        '>' => 123
    ],
    'fundraiser_id' => 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/teams/search"

	payload := strings.NewReader("{\n  \"text\": \"<string>\",\n  \"page\": 123,\n  \"limit\": 123,\n  \"sort\": \"<string>\",\n  \"direction\": \"<string>\",\n  \"email\": \"<string>\",\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  \"fundraiser_id\": 123,\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/teams/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  \"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  \"fundraiser_id\": 123,\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/teams/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  \"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  \"fundraiser_id\": 123,\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,
    "transaction_id": 12345678,
    "name": "Team A",
    "amount_goal": 1000,
    "amount_raised": 550,
    "created_at": "2022-03-01 00:00:00",
    "language": "en",
    "fundraiser": {
      "id": 101,
      "partner_id": 10,
      "fundraiser_template_id": 1,
      "name": "Gala Night",
      "url": "https://demo.crowdchange.co/101",
      "amount_goal": 1000,
      "user": {
        "id": 1,
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Snow",
        "title": "Mr.",
        "name": "John Snow"
      },
      "fundraiser_template": {
        "id": 1,
        "name": "Template"
      },
      "dt_start": "2021-01-01 08:00:00",
      "dt_end": "2021-01-01 16:00:00",
      "location": "100 Main Street, Toronto, ON",
      "organization_name": "Company Inc.",
      "tags_list": [
        "tag1",
        "tag2"
      ]
    },
    "user": {
      "id": 1,
      "email": "john@example.com",
      "first_name": "John",
      "last_name": "Snow",
      "title": "Mr.",
      "name": "John Snow"
    },
    "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"
      }
    ],
    "team_captain_mailing_address": {
      "address": "100 Main Street",
      "city": "Toronto",
      "state": "ON",
      "zip": "XXX XXX",
      "country": "CA"
    },
    "url": "https://demo.crowdchange.co/1/team/2"
  }
]

POST

private

teams

Find Team

curl --request POST \
  --url https://api.crowdchange.dev/v2/private/teams/search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "page": 123,
  "limit": 123,
  "sort": "<string>",
  "direction": "<string>",
  "email": "<string>",
  "created_at": {
    "<": "<string>",
    "<=": "<string>",
    "=": "<string>",
    ">=": "<string>",
    ">": "<string>"
  },
  "amount_goal": {
    "<": 123,
    "<=": 123,
    "=": 123,
    ">=": 123,
    ">": 123
  },
  "amount_raised": {
    "<": 123,
    "<=": 123,
    "=": 123,
    ">=": 123,
    ">": 123
  },
  "fundraiser_id": 123,
  "after_id": 123,
  "lang": "<string>",
  "filter_by_lang": 123,
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://api.crowdchange.dev/v2/private/teams/search"

payload = {
    "text": "<string>",
    "page": 123,
    "limit": 123,
    "sort": "<string>",
    "direction": "<string>",
    "email": "<string>",
    "created_at": {
        "<": "<string>",
        "<=": "<string>",
        "=": "<string>",
        ">=": "<string>",
        ">": "<string>"
    },
    "amount_goal": {
        "<": 123,
        "<=": 123,
        "=": 123,
        ">=": 123,
        ">": 123
    },
    "amount_raised": {
        "<": 123,
        "<=": 123,
        "=": 123,
        ">=": 123,
        ">": 123
    },
    "fundraiser_id": 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>',
    created_at: {
      '<': '<string>',
      '<=': '<string>',
      '=': '<string>',
      '>=': '<string>',
      '>': '<string>'
    },
    amount_goal: {'<': 123, '<=': 123, '=': 123, '>=': 123, '>': 123},
    amount_raised: {'<': 123, '<=': 123, '=': 123, '>=': 123, '>': 123},
    fundraiser_id: 123,
    after_id: 123,
    lang: '<string>',
    filter_by_lang: 123,
    tags: ['<string>']
  })
};

fetch('https://api.crowdchange.dev/v2/private/teams/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/teams/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>',
    'created_at' => [
        '<' => '<string>',
        '<=' => '<string>',
        '=' => '<string>',
        '>=' => '<string>',
        '>' => '<string>'
    ],
    'amount_goal' => [
        '<' => 123,
        '<=' => 123,
        '=' => 123,
        '>=' => 123,
        '>' => 123
    ],
    'amount_raised' => [
        '<' => 123,
        '<=' => 123,
        '=' => 123,
        '>=' => 123,
        '>' => 123
    ],
    'fundraiser_id' => 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/teams/search"

	payload := strings.NewReader("{\n  \"text\": \"<string>\",\n  \"page\": 123,\n  \"limit\": 123,\n  \"sort\": \"<string>\",\n  \"direction\": \"<string>\",\n  \"email\": \"<string>\",\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  \"fundraiser_id\": 123,\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/teams/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  \"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  \"fundraiser_id\": 123,\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/teams/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  \"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  \"fundraiser_id\": 123,\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,
    "transaction_id": 12345678,
    "name": "Team A",
    "amount_goal": 1000,
    "amount_raised": 550,
    "created_at": "2022-03-01 00:00:00",
    "language": "en",
    "fundraiser": {
      "id": 101,
      "partner_id": 10,
      "fundraiser_template_id": 1,
      "name": "Gala Night",
      "url": "https://demo.crowdchange.co/101",
      "amount_goal": 1000,
      "user": {
        "id": 1,
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Snow",
        "title": "Mr.",
        "name": "John Snow"
      },
      "fundraiser_template": {
        "id": 1,
        "name": "Template"
      },
      "dt_start": "2021-01-01 08:00:00",
      "dt_end": "2021-01-01 16:00:00",
      "location": "100 Main Street, Toronto, ON",
      "organization_name": "Company Inc.",
      "tags_list": [
        "tag1",
        "tag2"
      ]
    },
    "user": {
      "id": 1,
      "email": "john@example.com",
      "first_name": "John",
      "last_name": "Snow",
      "title": "Mr.",
      "name": "John Snow"
    },
    "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"
      }
    ],
    "team_captain_mailing_address": {
      "address": "100 Main Street",
      "city": "Toronto",
      "state": "ON",
      "zip": "XXX XXX",
      "country": "CA"
    },
    "url": "https://demo.crowdchange.co/1/team/2"
  }
]

Body

string

Search term.

integer

Page number. Default: 1

integer

Number of results to return. Default: 100

string

Key to sort by. Allowed values: id, name, amount_raised, amount_goal

string

Direction of sorting. Allowed values: asc, desc

string

Email filter.

object

Team’s creation date filter.

Show properties

string

object

Team’s amount goal filter.

Show properties

number

object

Team’s amount raised filter.

Show properties

number

integer

Campaign ID filter.

integer

Return teams after Team ID.

string

API’s locale. Allowed values: en, fr

integer

Filter teams only available in locale

string[]

List of fundraiser tags.

Response

Returns an array of objects with the following fields.

integer

Team ID.

integer

Transaction ID (if was created through transaction).

string

Team name.

number

Goal amount.

number

Amount raised by the team.

string

Creation date

string

Team language. Allowed values: en, fr

object

Show properties

integer

Fundraiser ID

integer

Site ID.

integer

Template ID.

string

Fundraiser name

string

Fundraiser URL

number

Fundraiser goal amount.

object

Show properties

integer

Fundraiser owner’s ID

string

Fundraiser owner’s email

string

Fundraiser owner’s first name

string

Fundraiser owner’s last name

string

Fundraiser owner’s title

string

Fundraiser owner’s name

object

Show properties

integer

Template ID.

string

Template Name.

string

Date and time when campaign starts.

string

Date and time when campaign ends.

string

Campaign location.

string

Organization associated with campaign.

any[]

Campaign tags.

object

Show properties

integer

Team captain’s ID

string

Team captain’s email

string

Team captain’s first name

string

Team captain’s last name

string

Team captain’s title

string

Team captain’s name

object[]

List of custom questions and responses.

Show properties

integer

Custom field id.

integer

If field was copied from Blueprint, this will reference the source field id from blueprint (similar to group id).

string

Custom field label.

string

User’s answer to custom field.

string

Custom ID.

string

Custom ID for the response (multiple choice questions).

object

Team captain’s mailing information. This can be registrant’s address, or mailing address, or billing address.

Show properties

string

Street Address.

string

City.

string

State or province.

string

Zip or Postal code.

string

ISO 3166-1 alpha-2 country code.

string

Full URL to team’s page.

Other responses

Status	Description
`400`	Bad Request
`403`	Forbidden

[
  {
    "id": 1,
    "transaction_id": 12345678,
    "name": "Team A",
    "amount_goal": 1000,
    "amount_raised": 550,
    "created_at": "2022-03-01 00:00:00",
    "language": "en",
    "fundraiser": {
      "id": 101,
      "partner_id": 10,
      "fundraiser_template_id": 1,
      "name": "Gala Night",
      "url": "https://demo.crowdchange.co/101",
      "amount_goal": 1000,
      "user": {
        "id": 1,
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Snow",
        "title": "Mr.",
        "name": "John Snow"
      },
      "fundraiser_template": {
        "id": 1,
        "name": "Template"
      },
      "dt_start": "2021-01-01 08:00:00",
      "dt_end": "2021-01-01 16:00:00",
      "location": "100 Main Street, Toronto, ON",
      "organization_name": "Company Inc.",
      "tags_list": [
        "tag1",
        "tag2"
      ]
    },
    "user": {
      "id": 1,
      "email": "john@example.com",
      "first_name": "John",
      "last_name": "Snow",
      "title": "Mr.",
      "name": "John Snow"
    },
    "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"
      }
    ],
    "team_captain_mailing_address": {
      "address": "100 Main Street",
      "city": "Toronto",
      "state": "ON",
      "zip": "XXX XXX",
      "country": "CA"
    },
    "url": "https://demo.crowdchange.co/1/team/2"
  }
]

Find Campaign

Find Personal Page

Introduction

Server Side APIs

Client Side APIs

Body

Response

​Body

​Response

Body

Response