Passer au contenu principal
POST
/
v2
/
private
/
teams
/
search
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>"
  ]
}
'
[
  {
    "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

​
text
string
Search term.
​
page
integer
Page number. Default: 1
​
limit
integer
Number of results to return. Default: 100
​
sort
string
Key to sort by. Allowed values: id, name, amount_raised, amount_goal
​
direction
string
Direction of sorting. Allowed values: asc, desc
​
email
string
Email filter.
​
created_at
object
Team’s creation date filter.
​
amount_goal
object
Team’s amount goal filter.
​
amount_raised
object
Team’s amount raised filter.
​
fundraiser_id
integer
Campaign ID filter.
​
after_id
integer
Return teams after Team ID.
​
lang
string
API’s locale. Allowed values: en, fr
​
filter_by_lang
integer
Filter teams only available in locale
​
tags
string[]
List of fundraiser tags.

​
Response

Returns an array of objects with the following fields.
​
id
integer
Team ID.
​
transaction_id
integer
Transaction ID (if was created through transaction).
​
name
string
Team name.
​
amount_goal
number
Goal amount.
​
amount_raised
number
Amount raised by the team.
​
created_at
string
Creation date
​
language
string
Team language. Allowed values: en, fr
​
fundraiser
object
​
user
object
​
custom_data
object[]
List of custom questions and responses.
​
team_captain_mailing_address
object
Team captain’s mailing information. This can be registrant’s address, or mailing address, or billing address.
​
url
string
Full URL to team’s page.
Other responses
StatusDescription
400Bad Request
403Forbidden
[
  {
    "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"
  }
]