In This Article:

    Activity Form Summary - Attendees

    In This Article:

      This API call returns the list of event attendees. 

      Request

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

      Parameters

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

       

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

      Response

      General Fields

      Name Type Description
      total Integer total attendees
      offset Integer offset. number of records (pagination)
      count Integer count of attendees in current response
      results Array Array of Attendee objects

       

      Attendee Fields

      Name Type Description
      firstName String attendee first name
      middleName String attendee middle name
      lastName String attendee 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 ifattendeeissupporter
      supporterExternalId String exists only ifattendeeissupporter
      type String Attendee type - will be one of:
      • PURCHASER
      • GUEST
      • FUNDRAISER - P2P only
      • TEAM_CAPTAIN - P2P only
      title String attendee title
      ticketName String ticket name
      purchasedBy String supporter that purchased the ticket for the attendee
      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
       
       

      Ticketed Event Response

      {
       "id": "6d9f123a-6b08-449c-85c1-1e3373bd2566",
        "timestamp": "2018-02-07T15:50:52.971Z",
        "header": {
          "processingTime": 98,
          "serverId": "local"
        },
        "payload": {
            "total": 2,
            "offset": 0,
            "count": 2,
            "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": "3de21273-4958-4ea1-9317-6fd10257e2f8",
                "supporterExternalId": "12331",
                "type": "GUEST",
                "ticketName": "Named ticket",
                "purchasedBy": "John Smith",
                "status": "REGISTERED",
                "registrationDate": "2018-02-07T15:50:52.971Z",
                "questions": [
                  {
                    "question": "Color",
                    "answer": "red"
                  }
                ]
              },
              {
                "firstName": "First1",
                "lastName": "Last1",
                "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",
                "city": "New York",
                "addressLine1": "Addr1",
                "addressLine2": "Addr2",
                "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": "f52996e2-a732-4b18-8ffb-0adad0ba2684",
                "supporterExternalId": "12331",
                "type": "GUEST",
                "ticketName": "Named ticket",
                "purchasedBy": "John Smith",
                "status": "REGISTERED",
                "registrationDate": "2018-02-07T15:50:52.972Z",
                "questions": [
                  {
                    "question": "Color",
                    "answer": "red"
                  }
                ]
              }
            ]
         }
      }
      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.