In This Article:

    Fundraiser Metadata and Summary

    In This Article:

      This API call returns specific P2P fundraiser metadata and summary. 

      Request

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

      Parameters

      Name Type Mandatory/Optional Description
      UUID UUID mandatory UUID that identifies specific fundraiser

       

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

      Response

      Fields

      Name Type Description
      firstName String first name
      middleName String 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
      state String state
      stateCode String state code
      zipCode String zip
      country String country
      countryCode String country code
      supporterId UUID supporter id
      purchaserExternalId String supporter external id
      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
      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
      fundraiserId UUID fundraiser id
      teamCaptain Boolean is team captain

       

      Response

      {
        "id""84113d7e-f6f4-4fbe-aa76-80a1ba2cbefd",
        "timestamp""2018-02-08T12:59:10.778Z",
        "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",
          "state""New York",
          "stateCode""NY",
          "zipCode""61000",
          "country""United States",
          "countryCode""US",
          "supporterId""ea558a3c-fd63-4f1e-9056-122a8533e365",
          "purchaserExternalId""extId",
          "customFields": [
            {
              "name""customfield_color",
              "value""blue",
              "type""STRING",
              "customFieldType""Activity"
            }
          ],
          "fundraiserPageName""Fundraiser Main Page",
          "type""PERSONAL",
          "enabled"true,
          "fundraiserUrl""http://fundraiserurl.com",
          "goal": 200.0,
          "totalDonationsAmount": 14.5,
          "totalDonationsCount": 5,
          "lastTransactionDate""2018-02-08T12:59:10.778Z",
          "teamId""e78f67e3-7f9d-444e-9891-42b750489c95",
          "teamName""Team Name 1",
          "fundraiserId""22480922-89ee-4b64-a51f-120943b99a36",
          "teamCaptain"false
        }
      }

       

      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.