Skip to content

teamgroups.md

Latest commit

 

History

History
62 lines (46 loc) · 1.74 KB

teamgroups.md

File metadata and controls

62 lines (46 loc) · 1.74 KB

Team Groups

Team Groups associated with this instance of DonorDrive

This feature may not be available for all instances of DonorDrive.

Endpoints

Path Return Type Notes
/api/teamgroups/{groupCode} object To find {groupCode}, contact your DonorDrive Administrator.

Nested Resources

Team Groups support nested resources for accessing associated participants and teams:

Path Return Type Notes
/api/teamgroups/{groupCode}/participants array Returns participants on teams within this Team Group
/api/teamgroups/{groupCode}/teams array Returns teams within this Team Group

Examples

# Get all teams in a Team Group
GET /api/1.6/teamgroups/corporate-teams/teams

# Get all participants on teams within a Team Group
GET /api/1.6/teamgroups/corporate-teams/participants

Response

The response from the teamgroups endpoint is a team group object.

Example

[
  {
    "numParticipants": 80,
    "fundraisingGoal": 10000,
    "numTeams": 15,
    "groupCode": "dd",
    "sumDonations": 2500,
    "name": "DonorDrive",
    "numDonations": 55
  }
]

Fields

Field Type Description Guaranteed Filterable Notes
fundraisingGoal float This Team Group's goal Yes
groupCode string The key associated with this Team Group Yes
name string The name of this Team Group Yes
numDonations integer The number of donations this Team Group has received Yes
numParticipants integer The number of participants associated with this Team Group Yes
numTeams integer The number of teams associated with this Team Group Yes
sumDonations float The total sum of donations this Team Group has received Yes