This API Used to get all Contacts details associated with the specified event. API used at host side event admin and super admin can access this API. It will return data like firstName, lastName, email, phoneNumber and other details. To call this API, user have to pass query param with API URL like searchString, page, size and authentication key to authenticate user.
Here is the description of response attributes, which returns in the form of JSON.
Attribute | Description |
|---|---|
firstName | The contact's first name. It’s displayed the manage contacts in your engage and can be useful for searching. |
lastName | The contact's last name. It’s displayed the manage contacts in your engage and can be useful for searching. |
The contact's email address. It’s displayed the manage contacts in your engage and can be useful for searching. | |
orderNumber | It's contains the ticket order number. |
ticketNumber | it's contain the ticket number. |
ticketTypeName | Fetched ticket type names. |
autoAssignedSeqNumber | It's contains the automatically assigned sequence of number. |
id | It's contains the id of contact, if record exists in system. |
countryCode | It's contains the country code for phone number. Two-letter ISO code representing the country of the code. |
phoneNumber | The contact's phone number. It’s displayed the manage contacts in your engage and can be useful for searching. |
phoneNumberCSV | It's contains the phone number used for CSV upload includes country code and phone number both |
error | A human-readable message providing more details about the error. |
unSubscribed | It's contains return true or false value. |
countryCodeFromString | Two-letter ISO code representing the country of the code from string. |
Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.
Error Code | Error Description |
|---|---|
400 | The request could not be understood by the server due to malformed syntax. |
401 | You are not authorized to view the resource |
403 | Accessing the resource you were trying to reach is forbidden. |
404 | The resource you were trying to reach is not found. |
4030201 | Not Event Host |