Event Registrant Collection Endpoint

Use this endpoint to retrieve (GET) a list of registrants for the specified event.

Methods:

Click a method to view its documentation

GET

DescriptionTOP

Privileges required: campaign:read

Retrieve the collection of all registrants for the event specified using the event_id path parameter. 

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

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

eventId

path

Specifies the event for which to retrieve the registrants

limit

query

50

Specifies the number of results displayed per page of output, from 1 - 500, default = 50. See Paginated Output for more information on using limit.

Response CodesTOP

code

description

200

Request was successfully processed

401

Authentication failure

404

Event not found for specified eventId

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

email

string

The Registrant's email address

first_name

string

The Registrant's first (given) name

guest_count

integer

Number of guests the registrant is bringing to the event

id

string

Unique ID for the registrant

last_name

string

The Registrant's last (family) name

payment_status

string

The Registrant's payment status

registration_date

date

Date the registrant registered for the event

registration_status

string

The Registrant's registration status

ticket_id

string

Unique ID of the registrant's event ticket

updated_date

string

Most recent date registrant was updated

Example ResponseTOP

{
    "meta":{
        "pagination":{
        }
    },
    "results":[
        {
        "id":"001f5P-8pSt_Ltwl9h07YgtCvsmp9f2_mojTd-yukkVkwLCPLCXKk2te94yaY2OZoMT",
        "email":"name1@example.com",
        "first_name":"James",
        "last_name":"Jones",
        "guest_count":0,
        "payment_status":"NA",
        "registration_status":"REGISTERED",
        "registration_date":"2013-09-25T14:59:02.000Z",
        "updated_date":"2013-09-25T14:59:02.000Z",
        "ticket_id":"EBN6AQXZP"
        },
        {
        "id":"001f5P-8pSt_LvGUzqE9HCRdyfuyurTiFEtfCnBNd_Rvit6ExXG2GlEX1c0ZMWAsovj",
        "email":"name2@example.com",
        "first_name":"Jane",
        "last_name":"Jones",
        "guest_count":0,
        "payment_status":"NA",
        "registration_status":"REGISTERED",
        "registration_date":"2013-09-17T14:17:30.000Z",
        "updated_date":"2013-09-17T14:17:30.000Z",
        "ticket_id":"E8Y3STTU6"
        }
    ]
}