Individual Event Registrant Endpoint

Use this API to retrieve (GET) detailed information for a specific event registrant.

Methods:

Click a method to view its documentation

GET

DescriptionTOP

Privileges required: campaign:read

Retrieve detailed information about a specific registrant (specified by registrantId) for an event (specified by eventId).

GET: https://api.constantcontact.com/v2/eventspot/events/{eventId}/registrants/{registrantId}

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

eventId

path

Unique ID of the event for which to retrieve the registrant details

registrantId

path

Unique ID of the registrant to retrieve

Response CodesTOP

code

description

200

Request was successful

401

The eventId or registrantId provided does not exist

404

Authentication failure

406

Unsupported Accept Header value, must be application/json

500

Internal server error occurred

Response StructureTOP

property

type(max length)

description

attendance_status

string

The Registrant's attendance status, ATTENDED or NOT_ATTENDED

+ fees

array

An array of fee properties.

+ guest_info

array

Array of guest_section objects, one for each guest, showing the detailed information for a guest

+ guest_section

object

For each guest, displays the values for each guest-related field shown on the registration form, in the fields array

+ guests

object

Contains all the guest information fields and values, entered by the registrant on the event registration page.

id

string

Unique registrant ID

+ items*

array

This section displays all items included in the order

+ order

object

Array of properties showing the registrant's total order.

+ payment_summary

object

Displays the payment_status and payment_type

+ promo_code_info

array

Displays information for any promocodes redeemed with this order. See Promocode Collection for explanation of promocode properties and business logic.

registration_date

string

Date of the registration, in ISO-8601 format

registration_status

string

Registrant's registration status, valid values are:

  • REGISTERED
  • CANCELLED - Registration was cancelled
  • ABANDONED - The registrant completed the registration form but did not complete the online payment process through PayPal, ProPay or Authorize.net; abandoned registrants are not inlcuded in registration reports.

+ sections

array

Displays registrant's personal information, grouped by the fields displayed on the event registration page

ticket_id

string

Unique ID of the registrant's event ticket

Example ResponseTOP

{
   "id":"001-nu-rFIacqyhbh9DX_dQz6J0aYSIEE-7BNGRLxQ39iEl_8FfFM-UyyP07AMERY0m9rjqW2_TrTw=",
   "sections":[
      {
         "label":"Personal Information",
         "fields":[
            {
               "type":"single_value",
               "name":"NAME_FIRST",
               "label":"First Name:",
               "value":"Ronnie"
            },
            {
               "type":"single_value",
               "name":"NAME_LAST",
               "label":"Last Name:",
               "value":"Mack"
            },
            {
               "type":"single_value",
               "name":"EMAIL_ADDRESS",
               "label":"Email Address:",
               "value":"rmack@example.com"
            }
         ]
      }
   ],
   "ticket_id":"E52UN85U4",
   "registration_date":"2014-02-17T15:23:53.371Z",
   "guests":{
      "guest_count":2,
      "guest_info":[
         {
            "guest_id":"001-nu-rFIacqyhbh9DX_dQz6J0aYSIEE-7BNGRLxQ39iGCOPym9L7rqqtEIxHXJdZ4",
            "guest_section":{
               "label":"Guest Information",
               "fields":[
                  {
                     "type":"single_value",
                     "name":"GUEST_NAME_FIRST",
                     "label":"First Name:",
                     "value":"Bill"
                  },
                  {
                     "type":"single_value",
                     "name":"GUEST_NAME_LAST",
                     "label":"Last Name:",
                     "value":"Hooper"
                  }
               ]
            }
         },
         {
            "guest_id":"001-nu-rFIacqyhbh9DX_dQz6J0aYSIEE-7BNGRLxQ39iGzkFwJ2_yFfjc7SpFgvbpt",
            "guest_section":{
               "label":"Guest Information",
               "fields":[
                  {
                     "type":"single_value",
                     "name":"GUEST_NAME_FIRST",
                     "label":"First Name:",
                     "value":"Mary"
                  },
                  {
                     "type":"single_value",
                     "name":"GUEST_NAME_LAST",
                     "label":"Last Name:",
                     "value":"Cardillo"
                  }
               ]
            }
         }
      ]
   },
   "payment_summary":{
      "order":{
         "total":169.0,
         "fees":[
            {
               "id":"PvtgiFHC9rr0cLdpwMrDY4PJUvBGM9P1V53KQcYO8Aw",
               "name":"Ronnie Mack",
               "type":"My Fee",
               "quantity":1,
               "amount":54.0,
               "fee_period_type":"EARLY",
               "promo_type":"DISCOUNT"
            },
            {
               "id":"PvtgiFHC9rr0cLdpwMrDY4PJUvBGM9P1V53KQcYO8Aw",
               "name":"Bill Hooper",
               "type":"My Fee",
               "quantity":1,
               "amount":54.0,
               "fee_period_type":"EARLY",
               "promo_type":"DISCOUNT"
            },
            {
               "id":"PvtgiFHC9rr0cLdpwMrDY4PJUvBGM9P1V53KQcYO8Aw",
               "name":"Mary Cardillo",
               "type":"My Fee",
               "quantity":1,
               "amount":54.0,
               "fee_period_type":"EARLY",
               "promo_type":"DISCOUNT"
            }
         ],
         "items":[
            {
               "id":"PvtgiFHC9rr0cLdpwMrDY4PJUvBGM9P1V53KQcYO8Aw",
               "name":"Golf Shirt w/logo",
               "type":"Hi-Vis Green",
               "quantity":1,
               "amount":32.0
            },
            {
               "id":"PvtgiFHC9rr0cLdpwMrDY7IwqpZ7nzW2Y09fUs00t3Q",
               "name":"gyrocopter",
               "type":"Color - Red",
               "quantity":1,
               "amount":10.0
            },
            {
               "id":"PvtgiFHC9rr0cLdpwMrDY7IwqpZ7nzW2Y09fUs00t3Q",
               "name":"gyrocopter",
               "type":"Color - Purple",
               "quantity":1,
               "amount":10.0
            }
         ],
         "order_id":"PR1-8955280",
         "currency_type":"USD",
         "order_date":"2014-02-17T15:23:53.372Z"
      },
      "payment_status":"PENDING",
      "payment_type":"CHECK",
      "promo_code":{
         "total_discount":-45.0,
         "promo_code_info":{
            "code_name":"REDUCED_FEE",
            "code_type":"DISCOUNT",
            "redemption_count":3,
            "discount_amount":15.0,
            "discount_type":"AMOUNT",
            "discount_scope":"FEE_LIST"
         }
      }
   }
}