In This Article:

    Team Metadata and Summary

    In This Article:

      This API call returns specific P2P team metadata and summary. 

      Request

      • Method: GET
      • URL: https://hq.salsalabs.org/api/developer/ext/v1/activities/teams/UUID

      Parameters

      Name

      Type

      Mandatory/Optional

      Description

      UUID

      UUID

      mandatory

      UUID that identifies specific team

       

      Example: https://hq.salsalabs.org/api/developer/ext/v1/activities/teams/ce5025ce-e519-4c6d-a604-54804c4dce23

      Response

      Fields

      Name
      Type
      Description

      firstName

      String

      first name

      middleName

      String

      fundraiser middle name

      lastName

      String

      last name

      gender

      String

      gender:

      • FEMALE

      • MALE

      • OTHER

      dateOfBirth

      Date

      fundraiser date of birth. ISO_8601 formatted String with a GMT timezone

      title

      String

      fundraiser title

      suffix

      String

      fundraiser suffix

      email

      String

      email

      homePhone

      String

      home phone

      cellPhone

      String

      cell phone

      workPhone

      String

      work phone

      city

      String

       city

      addressLine1

      String

      address line 1

      addressLine2

      String

      address line 2

      preferredLanguage

      String

      preferred language

      state

      String

      state

      stateCode

      String

      state code

      zipCode

      String

      zip

      country

      String

      country

      countryCode

      String

      country code

      supporterId

      UUID

      supporter id

      supporterExternalId

      String

      supporter external id

      teamPageName

      String

      team page name

      customFields

      Array

      Array of custom fields with values with the following attribtues

      • name - name of the custom field

      • value - value of the custom field

      • type - data type of the custom field. Values:

        • NUMBER

        • BOOLEAN

        • DOUBLE

        • STRING

        • DATE

      • customFieldType - possible values: 

        • Activity

        • Supporter

      type

      String

      Fundraiser type - will be one of:

      • PERSONAL

      • TEAM

      • ABANDONED

      enabled

      Boolean

      fundraiser enabled: yes/no

      teamUrl

      String

      team URL

      goal

      Double

      fundraiser goal value

      totalDonationsAmount

      Double

      total donations amount (dollars)

      totalDonationsCount

      Integer

      total donations count

      lastTransactionDate

      Date

      last transaction date. ISO_8601 formatted String with a GMT timezone

      teamId

      UUID

      team id

      fundraiserId

      UUID

      fundraiser id

      teamCaptainName

      String

      team captain name

      teamCaptainId

      UUID

      team captain id

       

      Response

      {
        "id""2e4141b0-cc21-4d14-a53a-3db97235b448",
        "timestamp""2018-02-08T13:26:43.742Z",
        "header": {
          "processingTime"98,
          "serverId""local"
        },
        "payload": {
          "firstName""FirstName",
          "middleName""MiddleName",
          "lastName""LastName",
          "gender""OTHER",
          "dateOfBirth""1996-01-21T16:31:58.801Z",
          "title""Title",
          "suffix""Suf",
          "email""email@mail.com",
          "homePhone""19111111111",
          "cellPhone""19111111111",
          "workPhone""19111111111",
          "city""City",
          "addressLine1""Addr1",
          "addressLine2""Addr2",
          "preferredLanguage" "en-US",
          "state""New York",
          "stateCode""NY",
          "zipCode""61000",
          "country""United States",
          "countryCode""US",
          "supporterId""724390bd-06cd-4816-96c2-d012eeff94cd",
          "supporterExternalId""extId",
          "customFields": [
            {
              "name""customfield_color",
              "value""blue",
              "type""STRING",
              "customFieldType""Activity"
            }
          ],
          "fundraiserPageName""Team Main Page",
          "type""TEAM",
          "enabled"true,
          "fundraiserUrl""http://teamurl.com",
          "goal"200.0,
          "totalDonationsAmount"14.5,
          "totalDonationsCount"5,
          "lastTransactionDate""2018-02-08T13:26:43.742Z",
          "teamId""f9242f38-adef-4ff6-974d-49cce9cc037c",
          "teamMembersCount"5,
          "teamCaptainName""Captain Name",
          "teamCaptainId""6d6084a7-35ca-47fd-980d-15b84aea0227"
        }
      }

       

       

      Was this article helpful?
      0 out of 0 found this helpful
      Have more questions? Submit a request

      Comments

      0 comments

      Please sign in to leave a comment.