Use this API to retrieve (GET) detailed information for a specific event registrant.
Click a method to view its documentation
Retrieve a specific partner webhook topic by specifying the
topicId
path parameter. See the available topic ID's
here
.
Privileges required : campaign:read
Retrieves the email campaign message specified by the
campaignId
path parameter. The
tracking_summary data
is current as of the last scheduled update, unless you set
updateSummary
=true to return updated data.
NOTE: Details of a deleted campaign cannot be retrieved. If a call is made to GET a deleted campaign by its ID, the call will fail and return a 404 Not Found response. You can login to the account to restore the campaign and then retrieve its details.
Privileges required : contacts:lists:read
GET a specific contact list (specified using the
listId
path parameter).
Privileges required : mylibrary:folder:read
Retrieve a specific MyLibrary folder using the
folderId
path parameter.
Privileges required : mylibrary:file:read
Retrieve a MyLibrary file using the
fileId
path parameter.
Privileges required : campaign:read
Retrieve an event item by using the
eventId
and
itemId
path parameters to specify the event and item.
Privileges required : campaign:read
Retrieve a list of all items for an event specified using the
eventId
path parameter.
Privileges required : campaign:read
Get a specific event object (specified by the
event_id
path parameter). Properties with a null value are not returned in the JSON response.
Privileges required : campaign:read
Retrieve detailed information about a specific registrant (specified by
registrantId
) for an event (specified by
eventId
).
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/{registrantId} |
|||
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 |
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 |
property |
type (max length) |
description |
---|
- {
- "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"
- }
- }
- }
- }