Events Collection Endpoint

Use this API endpoint to view (GET) all existing events, or create (POST) a new event.

Methods:

Click a method to view its documentation

GET POST

DescriptionTOP

Privileges required: campaign:list

Retrieve all events in a user's account.

GET: https://api.constantcontact.com/v2/eventspot/events

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

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 successful

401

Authentication failure

401

The eventId provided does not exist

406

Unsupported Accept Header value, must be application/json

500

Internal server error occurred

Response StructureTOP

property

type(max length)

description

active_date

string

Date event was published or announced, in ISO-8601 format

+ address

object

Address specifying the event location, used to determine event location on map if is_map_displayed set to true.

created_date

string

Date the event was created in ISO-8601 format

deleted_date

string

Date the event was deleted in ISO-8601 format

description

string (350)

Provide a brief description of the event that will be visible on the event registration form and landing page

end_date

string

The event end date, in ISO-8601 format

event_detail_url

string

URL that points to the detailed description of that event, same as a GET on a specific event.

id

string (26)

Unique ID of the event

is_checkin_available

boolean

Set to true to enable registrant check-in, and indicate that the registrant attended the event

location

string (50)

Name of the venue or Location at which the event is being held

name

string (100)

The event filename - not visible to registrants

registration_url

string (250)

Points to the event homepage if configured, otherwise points to the event registration page

start_date

string

The event start date, in ISO-8601 format

status

string

The event status, valid values are: DRAFT, ACTIVE, COMPLETE, CANCELLED, DELETED

time_zone_id

string (40)

Time zone in which the event occurs, to see time_zone_id values go here.

title

string (100)

The event title, visible to registrants

total_registered_count

integer

Number of event registrants

type

string

The event type, valid values are:
AUCTION, BIRTHDAY, BUSINESS_FINANCE_SALES
CLASSES_WORKSHOPS, COMPETITION_SPORTS
CONFERENCES_SEMINARS_FORUM, CONVENTIONS_TRADESHOWS_EXPOS
FESTIVALS_FAIRS, FOOD_WINE, FUNDRAISERS_CHARITIES
HOLIDAY, INCENTIVE_REWARD_RECOGNITION, MOVIES_FILM
MUSIC_CONCERTS, NETWORKING_CLUBS, PERFORMING_ARTS
OUTDOORS_RECREATION, RELIGION_SPIRITUALITY
SCHOOLS_REUNIONS_ALUMNI, PARTIES_SOCIAL_EVENTS_MIXERS
TRAVEL, WEBINAR_TELESEMINAR_TELECLASS
WEDDINGS, OTHER

Example ResponseTOP

{
    "meta":{
        "pagination":{
        }
    },
    "results":[
        {
        "id":"a07e1iw09oscc73adfe",
        "name":"Sep 30, 2013 - Apps-R-Us Event",
        "title":"My First Event",
        "status":"ACTIVE",
        "location":"The Great Room",
        "type":"CLASSES_WORKSHOPS",
        "address":{
          "city":"AnyCity",
          "state":"Massachusetts",
          "country":"United States",
          "latitude":42.125515,
          "longitude":-71.49862,
          "line1":"123 Maple Street",
          "line2":"",
          "line3":"",
          "state_code":"MA",
          "country_code":"us",
          "postal_code":"99999"
        },
        "description":"Please join our monthly seminar and learn some new skills while meeting new friends, and catching up with old friends.",
        "start_date":"2013-10-28T13:00:00.000Z",
        "end_date":"2013-10-28T21:00:00.000Z",
        "created_date":"2013-09-30T19:29:40.630Z",
        "time_zone_id":"US/Eastern",
        "active_date":"2013-09-30T19:37:44.006Z",
        "is_checkin_available":false,
        "event_detail_url":"/v2/eventspot/events/a07e1iw09oscc73adfe"
        }
    ]
}