In This Article:

    Activity Form Summary - Fundraisers

    In This Article:

      This API call returns the list of event fundraisers. 

      Request

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

      Parameters

      Name

      Type

      Mandatory/Optional

      Description

      UUID

      UUID

      mandatory

      Path param. UUID of the activity form

      count

      Integer

      optional

      Number of fundraiser records to be returned. Max = 25. Default = 10

      offset

      Integer

      optional

      Fundraiser records list offset for pagination

       

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

       

      Response

      General Fields

      Name

      Type

      Description

      total

      Integer

      total fundraisers

      offset

      Integer

      offset. number of records (pagination)

      count

      Integer

      count of fundraisers in current response

      results

      Array

      Array of Fundraiser objects

       

      Fundraiser Fields

      Name Type Description
      supporterID UUID fundraiser id
      firstName
      String fundraiser first name
      middleName String fundraiser middle name
      lastName
      String fundraiser 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
      formName
      String form name
      formId
      UUID form 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

      fundraiserPageName
      String fundraiser page name
      type
      String

      Fundraiser type - will be one of:

      • PERSONAL
      • TEAM
      • ABANDONED

       

      enabled
      Boolean fundraiser enabled: true/false
      fundraiserUrl
      String fundraiser 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
      teamName
      String team name
       

       

      Ticketed Event Response

      {
        "id": "6d01fbc3-04eb-4f0f-a1ef-59694b7c3b6b",
      "timestamp": "2018-02-07T16:31:58.801Z",
        "header": {
          "processingTime": 98,
          "serverId": "local"
        },
        "payload": {
            "total": 2,
            "offset": 0,
            "count": 2,
            "results": [
              {
                "supporterID": "da8891cc-8c0c-4feb-a50d-715084c69935",
                "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": "a35b04bf-056c-4e8e-8e61-65ca729978c3",
                "supporterExternalId": "extId",
                "formName": "Form Name",
                "formId": "61bbe05b-7d95-41c1-92f7-752f6ebef8d9",
                "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": "Fundraiser Main Page",
                "type": "PERSONAL",
                "enabled": true,
                "fundraiserUrl": "http://fundraiserurl.com",
                "goal": 200.0,
                "totalDonationsAmount": 14.5,
                "totalDonationsCount": 5,
                "lastTransactionDate": "2018-02-07T16:31:58.801Z",
                "teamId": "71b82eb2-499d-423a-b966-60797ed02eea",
                "teamName": "Team Name 1"
              },
              {
                "id": "79a42014-03e7-4b39-8c0d-fff209ce04a2",
                "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": "6f5e19de-5b2f-4817-95e6-0b3f973ba468",
                "supporterExternalId": "extId",
                "formName": "Form Name",
                "formId": "338e3b80-cc3e-4d96-b205-fb9d52d17a84",
                "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": "Fundraiser Main Page",
                "type": "PERSONAL",
                "enabled": true,
                "fundraiserUrl": "http://fundraiserurl.com",
                "goal": 200.0,
                "totalDonationsAmount": 14.5,
                "totalDonationsCount": 5,
                "lastTransactionDate": "2018-02-07T16:31:58.801Z",
                "teamId": "d3eb96a0-f864-4fd1-8371-dddf5d56f789",
                "teamName": "Team Name 1"
              }
            ]
         }
      }

       

      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.