Our v3 API is now available! Learn more by visiting the v3 developer portal . Creating new v2 API keys is no longer supported.

Event Item Collection

Event Items are products that are associated with an event that may be for sale or available at no cost. They are listed on an event registration page so that registrants can access them during the registration process. Use this API endpoint to create (POST) a new item and retrieve (GET) all existing items associated with an event.

Methods:

Click a method to view its documentation

GET POST

Description TOP

Privileges required : campaign:list

Retrieves the email campaigns in a user's account as follows:

  • all campaigns in the user's account (no query parameter specified)
  • campaigns with the status specified using the status query parameter; see the parameter table below for status types and definitions
  • campaigns modified on or after the date/time specified using the modified_since query parameter. This is useful for syncing email campaigns across applications.

Campaign sort order depends on the campaign status:

Status Campaign sort order
DRAFT by the latest modified_date
SENT by the latest last_run_date
SCHEDULED by the next_run_date
DELETED by the latest last_run_date if it was sent, or by the latest modified_date, if it was never sent

About DELETED campaigns

Deleted campaigns are included in a GET response only when status=DELETED query parameter is used. They  are not included in the GET collection by default. You cannot retrieve an individual deleted campaign object using the API.

Description TOP

Privileges required : mylibrary:file:read

Retrieve a list of MyLibrary folders and their properties for the authorized Constant Contact account. MyLibrary supports a folder hierarchy with 3 levels of nesting. Primary, child (2nd level) and grandchild (3rd level) folders all have the same properties associated with them. This endpoint returns an empty results array if there are no folders in the user's account.

Description TOP

Privileges required : mylibrary:file:read

The following options  are available when retrieving Library files:

  • Retrieve all files in all folders in the account - do not use any query parameters (except for api_key )
  • Retrieve all files with a specific type - use the type query parameter (ALL, IMAGE, or Document)
  • Retrieve all files from a specific source - use the source query parameter
  • Retrieve a specific file type from a specific source - use both the type and source query parameters

There are many options available for sorting the JSON response using the sort_by query parameter.

Description TOP

Privileges required : campaign:read

Retrieve an event item by using the eventId and itemId path parameters to specify the event and item.

Description TOP

Privileges required : campaign:read

Retrieve a list of all items for an event specified using the eventId path parameter.

Description TOP

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.

Description TOP

Privileges required : campaign:read

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

Description TOP

Privileges required : campaign:read

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

Description TOP

Privileges required : campaign:read

Retrieve a specific promotional code for an event; use the promocodeId and eventId path parameters to specify the code and the event it belongs to.

Description TOP

Privileges required : campaign:read

Retrieve all promocodes for an event specified by the eventId path parameter.

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

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 items

Response Codes TOP

code

description

200

Request was successful

401

Authentication failure

404

An event could not be found for the eventId provided

406

Unsupported Accept Header value, must be application/json

500

Internal server error occurred

Structure TOP

property

type (max length)

description

Example Response TOP 

  1. [
  2.     {   
  3.     "id":"9k7uXp6Hgyiq7BCC11zFc4PJUvBGM9P1V53KQcYO8Aw",
  4.     "name":"Running Belt",
  5.     "description":"Moisture Wicking, holds 2 bottles",
  6.     "price":20.25,
  7.     "attributes":[
  8.         {
  9.         "id":"9k7uXp6Hgyiq7BCC11zFc0XQU2aR_wPmDNJVddPgGWM",
  10.         "name":"Royal Blue",
  11.         "quantity_total":175,
  12.         "quantity_available":175
  13.         },
  14.         {
  15.         "id":"9k7uXp6Hgyiq7BCC11zFc476STDHQ_sadfwfRCYGMSU",
  16.         "name":"Hi-Vis Green",
  17.         "quantity_total":75,
  18.         "quantity_available":75
  19.         }
  20.     ],
  21.     "per_registrant_limit":1,
  22.     "show_quantity_available":true,
  23.     "default_quantity_total":250
  24.     },
  25.     {
  26.     "id":"9k7uXp6Hgyiq7BCC11zFc7IwqpZ7nzW2Y09fUs00t3Q",
  27.     "name":"Golf Shirt w/logo",
  28.     "description":"Underarmour moisture wicking material",
  29.     "price":32.0,
  30.     "attributes":[
  31.     ],
  32.     "per_registrant_limit":2,
  33.     "show_quantity_available":true,
  34.     "default_quantity_total":300,
  35.     "default_quantity_available":300
  36.     }
  37. ]
  38.