Get Invited Contact List

Get Invited Contact List

Get Invited Contact List

POST [PlatformAddress]/api/1.0/event?action=getInvitedContactList

Get a list of invited contact for event.

Request Body

Name	Type	Description
eventId	integer	The unique id of the event to which the invitation belong
start	integer	The starting result of the page. Note this is zero based (i.e. sending start=0 will start from the first result.)
perPage	integer	The number of invited contacts to fetch

200

{
    "meta": {
        "totalResults": 345,
        "start": 0,
        "perPage": 2,
        "count": 2
    },
    "results": [
        {
            "eventId": 1,
            "contactId": 1,
            "firstName": "Test",
            "lastName": "Last",
            "email": "[e-mail]",
            "phone": "1346789798",
            "response": "Y",
            "registrationId": 1,
            "modifiedDate": "2018-09-19 09:00:34 UTC"
        },
        {
            "eventId": 1,
            "contactId": 2,
            "firstName": "Test",
            "lastName": "Two",
            "email": "[e-mail]",
            "phone": "[phone]",
            "response": "U",
            "registrationId": null,
            "modifiedDate": "2018-09-19 08:57:11 UTC"
        }
    ]
}

The result from this call will be a collection of invited contact records the user has access to. This call also accepts the pagination and filter properties.

Returns

Property	Description	Type
eventId	The unique id of the event for invited contact	integer
contactId	The unique contact id of the invited contact	integer
firstName	The first name of the invited contact	integer
lastName	The last name of the invited contact	integer
email	The email of the invited contact	string
phone	The phone number of the invited contact	string
response	The response from the invited contact	string
registrationId	The registration id of the invited contact	integer
modifiedDate	The date & time the invited contact was last modified	datetime

Response

Status	Description
U	Undecided
Y	Yes
N	No