In This Article:

    Activity Form Summary - Registrations

    In This Article:

      This API call returns the list of event registrations. 

      Request

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

      Parameters

      Name
      Type
      Mandatory/Optional
      Description

      UUID

      UUID

      mandatory

      Path param. UUID of the activity form

      count

      Integer

      optional

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

      offset

      Integer

      optional

      Registration records list offset for pagination

       

      Example: https://dev-api.salsalabs.org/api/developer/ext/v1/activities/ce5025ce-e519-4c6d-a604-54804c4dce23/summary/registrations?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 Registration objects

       

      Registration Fields

      Name Type Description

      firstName

      String

      fundraiser first name

      middleName

      String

      middle name

      lastName

      String

      fundraiser last name

      gender

      String

      gender:

      • FEMALE

      • MALE

      • OTHER

      dateOfBirth

      Date

      date of birth. ISO_8601 formatted String with a GMT timezone

      title

      String

      title

      suffix

      String

      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

      homePhone

      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

      cellPhone

      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

      workPhone

      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

      exists only if

      attendee

      is

      supporter

      supporterExternalId

      String

      exists only if

      attendee

      is

      supporter

      ticketName

      String

      ticket name

      purchasedBy

      String

      purchased by

      status

      String

      Attendee status - will be one of:

      • VALID

      • CANCELED

      registrationDate

      Date

      registration date. ISO_8601 formatted String with a GMT timezone

      questions

      Array

      Array of questions with the following attributes:

      • question - text

      • answer - text

      fundraiserGoal

       Double

      fundraiser level goal

      totalDonationsAmount

       Double

      total donations amount (dollars)

       totalDonationsCount

       Integer

      total donations count

       optionalPurchases

       Boolean

      optional purchases: yes/no

       teamName

       String

      team name

      purchaseType

      String

      purchase type. Values:

      • PURCHASER

      • GUEST

      fundraiserAvaliable

      Boolean

      if fundraiser can be created

      fundraiserCreated

      String

      fundraiser creation state. Values:

      • N/A

      • Yes

      • Pending

      • No

      fundraiserPageName

       String

      page name

      teamCaptain

      Boolean

      if this is a team captain

       

      Ticketed Event Response

      {
      "id": "d8018f5b-2509-47ec-bfd4-ff3e15340010",
        "timestamp": "2018-02-07T16:02:48.720Z",
        "header": {
          "processingTime": 98,
          "serverId": "local"
        },
        "payload": {
            "total": 1,
            "offset": 0,
            "count": 1,
            "results": [
              {
                "firstName": "First0",
                "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": "New York",
                "addressLine1": "Addr1",
                "addressLine2": "Addr2",
      		  "preferredLanguage" : "en-US",
                "state": "New York",
                "stateCode": "NY",
                "zipCode": "11111",
                "country": "United States",
                "countryCode": "US",
                "addressStatus": "OptIn",
                "addressOptInDate": "1996-01-21T16:31:58.801Z",
                "addressOptOutDate": "1996-01-21T16:31:58.801Z",
                "supporterId": "3faee06a-c4fd-44af-8e1e-b8bc6e05c3df",
                "supporterExternalId": "12331",
                "ticketName": "Named ticket",
                "purchasedBy": "John Smith",
                "status": "Valid",
                "registrationDate": "2018-02-07T16:02:48.721Z",
                "questions": [
                  {
                    "question": "Color",
                    "answer": "red"
                  }
                ],
                "fundraiserGoal": "200",
                "totalDonationsAmount": "400",
                "totalDonationsCount": "15",
                "optionalPurchases": true,
                "teamName": "Team Number 1",
                "purchaseType": "Purchaser",
                "fundraiserAvaliable": "true",
                "fundraiserCreated": "true",
                "fundraiserPageName": "fund page",
                "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.