GET v1/event/{eventId}/guests?eventIdType={eventIdType}

Returns a list of all the guests associated with the specified Event.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
eventId

The unique identifier of an event.

integer

Required

eventIdType

Indicates whether the EventId specified is the Greenvelope EventId or a customer-provided EventId.

EventIdType

Default value is Greenvelope

Body Parameters

None.

Response Information

Resource Description

Returns a list of all the guests associated with the specified Event.

Collection of Guest
NameDescriptionTypeAdditional information
CardURL

URL to view the card for this guest

string

None.

CheckinStatus

Indicates whether the guest has checked in to the event. Value can be null.

boolean

None.

CheckinDateUtc

Indicates the Date/Time the guest was marked checked in. Value can be null

date

None.

Company

The name of the company this Guest is associated with.

string

None.

CustomFields

A list of the CustomField values for this Guest.

Collection of CustomField

None.

CreatedDateUtc

The date on which this guest's record was created. Returned as an ISO 8601 formatted date in UTC time (2014-01-20T12:00:00Z)

date

None.

Email

The email address of the guest.

string

None.

EnvelopeGreeting

Optional greeting to appear on the envelope for this guest's invitation. (Ex: "The Smiths")

string

None.

EventId

The unique identifier of the event to which this guest belongs.

integer

None.

FirstName

The first name of the guest.

string

None.

GuestAddlLimit

Number of Plus 1 guests the host has specified this guest may specify on the RSVP form.

integer

None.

GuestId

The unique identifier of a guest.

integer

None.

InvitationStatus

The status of this guest's invitation ("Self Registered", "Not Sent", "Sending", "Failed Send", "Sent", "Opened", "Responded", or "Unknown").

string

None.

IsInvited

Indicates whether this guest was actually invited to this event. If additional guests belonging to this primary guest are invited to the event, but the primary guest is not invited, the primary guest will be returned with a false value for this property.

boolean

None.

LastName

The last name of the guest.

string

None.

QuestionResponses

A list of the QuestionResponses for this Guest.

Collection of QuestionResponse

None.

RsvpComplete

Indicates whether all the required data on the RSVP form was submitted by the guest to make the RSVP considered complete.

boolean

None.

RsvpDateUtc

The date on which the guest has RSVP'd for the event. Returned as an ISO 8601 formatted date in UTC time (2014-01-20T12:00:00Z)

date

None.

RsvpMessage

The message this guest provided when RSVP-ing for the event.

string

None.

RsvpStatus

Indicates whether the guest RSVP'd yes or no to the event. Value can be null if the guest has not yet responded.

boolean

None.

Tags

The set of Tags assigned to this guest.

Collection of Tag

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.