In This Article:

    Activity Form Summary - Teams

    In This Article:

      This API call returns the list P2P form teams with details. 

      Request

      • Method: GET
      • URL: https://dev-api.salsalabs.org/api/developer/ext/v1/activities/UUID/summary/teams
      • Applicable to: P2P

      Parameters

      Name Type Mandatory/Optional Description
      UUID UUID mandatory Path param. UUID of the activity form
      count Integer optional Number of team records to be returned. Max = 25. Default = 10
      offset Integer optional Team records list offset for pagination

       

      Example: https://dev-api.salsalabs.org/api/developer/ext/v1/activities/ce5025ce-e519-4c6d-a604-54804c4dce23/summary/teams?count=15&offset=30

      Response

      General Fields

      Name Type Description
      total Integer total number of records available
      offset Integer starting offset for records
      count Integer count of records returned
      results Array Array of Team objects

       

      Team 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

      emailStatus

      String

      email contact status:

      • OptIn

      • OptOut

      emailOptInDate

      Date

      email contact opt in date. ISO_8601 formatted String with a GMT timezone

      emailOptOutDate

      Date

      email contact opt out date. ISO_8601 formatted String with a GMT timezone

      homePhone

      String

      home phone

      homePhoneStatus

      String

      home phone contact status:

      • OptIn

      • OptOut

      homePhoneOptInDate

      Date

      home phone contact opt in date. ISO_8601 formatted String with a GMT timezone

      homePhoneOptOutDate

      Date

      home phone contact opt out date. ISO_8601 formatted String with a GMT timezone

      cellPhone

      String

      cell phone

      cellPhoneStatus

      String

      cell phone contact status:

      • OptIn

      • OptOut

      cellPhoneOptInDate

      Date

      cell phone contact opt in date. ISO_8601 formatted String with a GMT timezone

      cellPhoneOptOutDate

      Date

      cell phone contact opt out date. ISO_8601 formatted String with a GMT timezone

      workPhone

      String

      work phone

      workPhoneStatus

      String

      work phone contact status:

      • OptIn

      • OptOut

      workPhoneOptInDate

      Date

      work phone contact opt in date. ISO_8601 formatted String with a GMT timezone

      workPhoneOptOutDate

      Date

      work phone contact opt out date. ISO_8601 formatted String with a GMT timezone

      city

      String

      city

      addressLine1

      String

      address line 1

      addressLine2

      String

      address line 2

      preferred language

      String

      preferredLanguage

      state

      String

      state

      stateCode

      String

      state code

      zipCode

      String

      zip

      country

      String

      country

      countryCode

      String

      country code

      addressStatus

      String

      address contact status:

      • OptIn

      • OptOut

      addressOptInDate

      Date

      address contact opt in date. ISO_8601 formatted String with a GMT timezone

      addressOptOutDate

      Date

      address contact opt out date. ISO_8601 formatted String with a GMT timezone

      supporterId

      UUID

      supporter id

      supporterExternalId

      String

      supporter external id

      referringUrl

      String

      referring URL

      salsaTrack

      String

      salsa track value

      customFields

      Array

      Array of custom fields with values with the following attributes

      • 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

        • Consent

      • optInDate

      • optOutDate

      both optInDate and optOutDate must be sent to get OptOut value in Consent custom fields

      teamPageName

      String

      team page name

      enabled

      Boolean

      enabled: yes/no

      teamUrl

      String

      team URL

      goal

      Double

      team 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

      teamMembersCount

      Integer

      number of team members

       

      Ticketed Event Response

      {
        "id": "375918a5-057a-4581-bf22-90712ad048e0",
      "timestamp": "2018-02-07T16:49:42.249Z",
        "header": {
          "processingTime": 98,
          "serverId": "local"
        },
        "payload": {
            "type": "P2P_EVENT",
            "total": 2,
            "offset": 0,
            "count": 2,
            "results": [
            {
              "firstName": "FirstName",
              "middleName": "MiddleName",
              "lastName": "LastName",
              "gender": "OTHER",
              "dateOfBirth": "1996-01-21T16:31:58.801Z",
              "title": "Title",
              "suffix": "Suf",
              "email": "email@mail.com",
              "emailStatus": "OptIn",
              "emailOptInDate": "1996-01-21T16:31:58.801Z",
              "emailOptOutDate": "1996-01-21T16:31:58.801Z",
              "homePhone": "19111111111",
              "homePhoneStatus": "OptIn",
              "homePhoneOptInDate": "1996-01-21T16:31:58.801Z",
              "homePhoneOptOutDate": "1996-01-21T16:31:58.801Z",
              "cellPhone": "19111111111",
              "cellPhoneStatus": "OptIn",
              "cellPhoneOptInDate": "1996-01-21T16:31:58.801Z",
              "cellPhoneOptOutDate": "1996-01-21T16:31:58.801Z",
              "workPhone": "19111111111",
              "workPhoneStatus": "OptIn",
              "workPhoneOptInDate": "1996-01-21T16:31:58.801Z",
              "workPhoneOptOutDate": "1996-01-21T16:31:58.801Z",
              "city": "City",
              "addressLine1": "Addr1",
              "addressLine2": "Addr2",
              "preferredLanguage" : "en-US",
              "state": "New York",
              "stateCode": "NY",
              "zipCode": "61000",
              "country": "United States",
              "countryCode": "US",
              "addressStatus": "OptIn",
              "addressOptInDate": "1996-01-21T16:31:58.801Z",
              "addressOptOutDate": "1996-01-21T16:31:58.801Z",
              "supporterId": "6abb1c4a-58e5-4d55-a495-151507475e15",
              "supporterExternalId": "extId",
              "formId": "929f5586-bf32-406a-9718-a014636ed140",
              "referringUrl": "http://refurl.salsalabs.org",
              "salsaTrack": "trackvalue123",
              "customFields": [
                {
                  "name": "customfield_color",
                  "value": "blue",
                  "type": "STRING",
                  "customFieldType": "Supporter",
                  "optInDate": "1996-01-21T16:31:58.801Z",
                  "optOutDate": "1996-01-21T16:31:58.801Z"
                }
              ],
              "fundraiserPageName": "Team Main Page",
              "enabled": true,
              "fundraiserUrl": "http://teamurl.com",
              "goal": 200.0,
              "totalDonationsAmount": 14.5,
              "totalDonationsCount": 5,
              "lastTransactionDate": "2018-02-07T16:49:42.250Z",
              "teamId": "d2486487-98d1-4d66-8f1c-b0e797172827",
              "teamName": "Team Captain Name",
              "teamMembersCount": 25,
            },
            {
              "firstName": "FirstName",
              "middleName": "MiddleName",
              "lastName": "LastName",
              "gender": "OTHER",
              "dateOfBirth": "1996-01-21T16:31:58.801Z",
              "title": "Title",
              "suffix": "Suf",
              "email": "email@mail.com",
              "emailStatus": "OptIn",
              "emailOptInDate": "1996-01-21T16:31:58.801Z",
              "emailOptOutDate": "1996-01-21T16:31:58.801Z",
              "homePhone": "19111111111",
              "homePhoneStatus": "OptIn",
              "homePhoneOptInDate": "1996-01-21T16:31:58.801Z",
              "homePhoneOptOutDate": "1996-01-21T16:31:58.801Z",
              "cellPhone": "19111111111",
              "cellPhoneStatus": "OptIn",
              "cellPhoneOptInDate": "1996-01-21T16:31:58.801Z",
              "cellPhoneOptOutDate": "1996-01-21T16:31:58.801Z",
              "workPhone": "19111111111",
              "workPhoneStatus": "OptIn",
              "workPhoneOptInDate": "1996-01-21T16:31:58.801Z",
              "workPhoneOptOutDate": "1996-01-21T16:31:58.801Z",
              "city": "City",
              "addressLine1": "Addr1",
              "addressLine2": "Addr2",
              "preferredLanguage" : "en-US",
              "state": "New York",
              "stateCode": "NY",
              "zipCode": "61000",
              "country": "United States",
              "countryCode": "US",
              "addressStatus": "OptIn",
              "addressOptInDate": "1996-01-21T16:31:58.801Z",
              "addressOptOutDate": "1996-01-21T16:31:58.801Z",
              "supporterId": "18e3b31f-3f82-4a42-88fd-4a3fd4349770",
              "supporterExternalId": "extId",
              "formId": "f8f46bb1-6119-4ec3-8dee-8f3de3c9740a",
              "referringUrl": "http://refurl.salsalabs.org",
              "salsaTrack": "trackvalue123",
              "customFields": [
                {
                  "name": "customfield_color",
                  "value": "blue",
                  "type": "STRING",
                  "customFieldType": "Supporter",
                  "optInDate": "1996-01-21T16:31:58.801Z",
                  "optOutDate": "1996-01-21T16:31:58.801Z"
                }
              ],
              "fundraiserPageName": "Team Main Page",
              "enabled": true,
              "fundraiserUrl": "http://teamurl.com",
              "goal": 200.0,
              "totalDonationsAmount": 14.5,
              "totalDonationsCount": 5,
              "lastTransactionDate": "2018-02-07T16:49:42.250Z",
              "teamId": "16664e6d-82c0-42e8-a1ef-6f10b7a063fe",
              "teamName": "Team Captain Name",
              "teamMembersCount": 25,
            }
          ]
        }
      }
      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.