Endpoints
Account
Represents a single Greenvelope account.
| API | Description |
|---|---|
| GET v1/account/{accountId} |
Returns a single Greenvelope account for the given AccountId. |
| GET v1/account?email={email} |
Returns a single Greenvelope account for the given email address. |
| GET v1/account/{accountId}/list |
Returns a list of Greenvelope accounts managed by the signed in account. |
| POST v1/account/{accountId}/createtoken |
Created a signed JWT token |
Viewer
Used for the guest RSVP functionality.
| API | Description |
|---|---|
| PUT v1/event/{eventId}/register |
Registers a single guest for the given EventId. |
| PUT v1/event/{eventId}/updatersvp |
Updates RSVP information for a single specified guest for the given EventId. |
| GET v1/receivedmailings?recipientEmailAddress={recipientEmailAddress}&includeLocations={includeLocations} |
Return a list of events received by the given email address. |
GuestAdditional
Represents a person attending an event in addition to the primary Guest. The host of the event typically defines these additional guests.
| API | Description |
|---|---|
| GET v1/guestadditional/{guestAdditionalId} |
Returns a single additional guest for the given GuestAdditionalId. |
| GET v1/event/{eventId}/guestadditionals |
Returns a list of all the additional guests associated with the specified Event. |
Guest
Represents a person attending a single event.
| API | Description |
|---|---|
| GET v1/guest/{guestId} |
Returns a single guest for the given GuestId. |
| GET v1/event/{eventId}/guests?eventIdType={eventIdType} |
Returns a list of all the guests associated with the specified Event. |
Event
Represents a single Greenvelope event.
| API | Description |
|---|---|
| GET v1/event/{eventId}/archive |
Archives the specified event. |
| GET v1/event/{eventId}/delete |
Deletes the specified event. |
| GET v1/event/{eventId}/summary |
Provides summary data for the specified event. |
| GET v1/event/{eventId} |
Returns a single Greenvelope event for the given EventId. |
| GET v1/account/{accountId}/events |
Returns a list of all the active Greenvelope events for the given account. |
User
Represents a cohost associated with an single event.
| API | Description |
|---|---|
| GET v1/event/{eventId}/cohosts?eventIdType={eventIdType} |
Returns a list of all the email address of each cohost associated with the specified Event. |
Authenticate
Used for generating authentication tokens.
| API | Description |
|---|---|
| POST v1/authenticate/jwttoken |
Authenticates the supplied JwtToken and returns an access token. |
| POST v1/authenticate/apipassword?email={email} |
Authenticates the supplied ApiPassword and returns an access token. |