Get Contact
post
[PlatformAddress]/api/1.0/contact?action=getContact
Get Contact
This example request will obtain the details of the contact with the id "6"
{
"id":6
}
Property | Description | Type |
id | The unique identifier for the contact | integer |
firstName | The contact’s first name | string |
lastName | The contact’s last name | string |
email | The contact’s email address | string |
phone | The contact’s phone number | integer |
status | enum | |
smsStatus | enum | |
customFields | The custom field information for the contact. This is an array of fields, each an object with the keys. | array |
groups | The subscription group information for the contact. | array |
companies | This will an array company ids to which the contact belongs. | array |
companiesData | This will an array company containing id and businessName for each company to which the contact belongs. | array |
externalId | This will be an external id of the contact | integer |
modifiedDate | The modified date of the contact | date |
eventInvitations | An array of events the contact has been invited to. Each element of the array is an object with the event invitations fields | array |
eventRegistrations | An array of events the contact has registered for. Each element of the array is an object with the event registration fields. | array |
The status is the record of whether the contact has opted in to email communication.
# | Description |
1 | Subscribed |
2 | Unsubscribed |
3 | Bounced |
4 | Registering |
5 | No Marketing |
The sms status is the record of whether the contact has opted in to sms communication.
# | Description |
1 | Subscribed |
2 | Unsubscribed |
3 | Failed |
4 | No Marketing |
Keys |
fieldId |
displayName |
value |
Property | Description |
eventId | The event identifier of the invitation |
eventCode | The code of the event of the invitation |
eventStartDateTime | The timestamp the event is starting |
inviteLinkYes | Invitation link for the Yes response for this contact to the event |
inviteLinkNo | Invitation link for No response for this contact to the event |
response |
# | Description |
U | Undecided |
Y | Yes |
N | No |
Property | Description |
eventId | The event identifier of the registration |
eventCode | The code of the event of the registration |
eventStartDateTime | The timestamp the event is starting |
registrationId | The unique identifier of the registration |
currentStatus | |
confirmedDate | Timestamp of the date the registration was confirmed |
isPaymentWaiting | If the registration is payment waiting or not |
printTicketUrl | The URL the registrations tickets |
printTicketUrlPdf | Link to the PDF for the registrations tickets |
attendeeCount | Total number of attendees for this registration |
invoiceUrl | The URL for the registration primary invoice |
invoiceUrlPdf | Link to the PDF for the registration primary invoice |
guestDetails | |
invoices | The list of invoices associated with the registration. Each element of the array is an object with the invoice fields. |
# | Description |
2 | Completed |
3 | Cancelled |
4 | Payment Required |
Property | Description |
contactId | The identifier for the contact if known |
fullName | Name of guest |
email | Email address of guest |
attended | If the contact has attended the event |
attendedDateTime | When the contact attended the event |
Property | Description |
id | The unique identifier for the invoice |
reference | The reference number of the invoice |
title | The title of the invoice |
currentStatus | The current status of the invoice. The value of this field will be one of the following current status. |
description | The description of the invoice |
currency | The currency of the values of this invoice |
totalCost | The total amount of the invoice |
totalPaid | How much has been paid off the invoice |
invoiceUrl | The URL for the invoice |
invoiceUrlPdf | The URL for the invoice pdf |
# | Description |
0 | Not Paid |
1 | Unconfirmed Paid |
2 | Written Off |
3 | Failed |
4 | Cancelled |
5 | Refunded |
The result from this call will be a collection of all the events the user has access to. This call also accepts the pagination and filter properties.
Code | Description |
Specific Code: 24096 | Unable to find contact |
The contact identifier must be provided to fetch a specific contact from the system.
Last modified 1yr ago