iVvy Developer API
  • API Documentation
  • Getting Started
    • Obtaining Keys
    • Creating the request
      • Method/URI Header
      • Request Headers
        • Standard Headers
        • Custom Headers
      • Signing the request
      • Query Parameters
    • Test Ping
    • Interpreting the response
      • Collections
      • Pagination
      • Filtering
      • Exceptions
      • Response Headers
      • Dates
    • Batch
      • Run
      • Progress
      • Result
      • Restart
      • Repost
    • Use Cases
      • CRM Systems
      • Financial Accounting Systems
      • Point Of Sale
      • Property Management Systems
  • Contacts & Companies
    • Get Contact List
    • Get Contact
    • Get Contact Note List
    • Add or Update Contact
    • Get Contact Custom Field Definition
    • Get Company Custom Field Definition
    • Get Subscription Group List
    • Add Contacts To Subscription Group
    • Remove Contacts From Subscription Group
    • Get Company List
    • Get Company
    • Get Company Note List
    • Add or Update Company
    • Add or Update Lead
    • Add or Update Contact Note
    • Add or Update Company Note
  • Event
    • Add or Update Event
    • Get Event List
    • Get Event
    • Get Registration
    • Get Registration List
    • Get Attendee
    • Get Attendee List
    • Get Invited Contact List
    • Invite Contacts
    • Get Sponsorship List
    • Get Speaker List
    • Get Session List
    • Create Login Token
  • Venue
    • Venue Setup Data
      • Get Venue
      • Get Venue List
      • Get Venue Room List
      • Get Venue Room Option List
      • Get Venue Rate Plan List
      • Get Venue Rate Plan Rate List
      • Get Venue Rate Plan Room Rate List
      • Get Resource List
      • Get Resource Availability
      • Get Menu List
      • Get Beverage Package List
      • Get Function Space List
      • Get Space Blockout List
      • Get Function Space Category List
      • Get Function Space Availability
      • Get Function Space Hire Plan Rate List
      • Get Function Space Hire Plan Rate
      • Get Cost Center List
      • Get Session Type List
      • Get Revenue Template List
      • Get Tax List
      • Add or Update Function Space
      • Get Event Type List
      • Add or Update Function Space Category
      • Add or Update Guest Room
      • Get Booking Custom Field List
      • Get Space Hire Plans
      • Get Venue Package List
      • Get Venue Package
    • Booking Data
      • Convert Lead To Opportunity
      • Add or Update Opportunity
      • Get Booking
      • Get Booking List
      • Get Booking List For Account
      • Get Booking Notes
      • Get Booking Session List
      • Get Booking Session Menu List
      • Get Booking Changelog List
      • Get Booking Attendee (By Hash)
      • Get Booking Attendee List
      • Get Booking Release Schedule
      • Add or Update Booking
      • Change Booking Status
      • Add Items To Booking
      • Add Payment To Booking
      • Add Refund To Booking
      • Add or Update Booking Attendee
      • Add or Update Booking Note
      • Add or Update Booking Session
      • Add or Update Booking Session Beverage
      • Add or Update Booking Session Menu
      • Add or Update Booking Session Resource
      • Remove Booking Session
      • Remove Booking Session Beverage
      • Remove Booking Session Menu
      • Remove Booking Session Resource
      • Get Space Blockout List
      • Add or Update Blockout Space
      • Remove Blockout Space
      • Get Booking Tax List
      • Add or Update Opportunity Note
      • Upload Booking Document
    • Booking Accommodation Data
      • Get Booking Accommodation List
      • Add or Update Booking Accommodation
      • Remove Booking Accommodation
      • Get Booking Room Reservation List
      • Add or Update Booking Room Reservation
      • Update Room Reservation Guest Contact
      • Remove Booking Room Reservation
      • Confirm Booking Room Reservation
      • Cancel Booking Room Reservation
      • Change Status of Booking Room Reservation
      • Add or Update Room Counts
      • Add or Update Room Dynamic Rates
      • Remove Room Dynamic Rates
      • Add or Update Rate Plan Booking Rules
  • Partner
    • Get Venue List
    • Get Venue
  • Invoice
    • Get Invoice List
    • Get Invoice
    • Get Options
    • Add Payment
    • Get Credit Note List
    • Get Credit Note
  • Account
    • Add or Update Cost Center
    • Get Cost Center List
    • Get Email Log List
    • Add Error Report
    • Get Account User List
  • CRM
    • Get Lead List
    • Get Opportunity List
    • Get Opportunity Note List
    • Get Task List
    • Get Activity List
    • Get Lead Stage List
    • Get Lead Type List
    • Get Lead Quality List
    • Get Lead Source List
    • Get Lead Channel List
    • Get Lead Note List
    • Add or Update Activity Purpose
    • Add or Update Activity
    • Add or Update Task
    • Add or Update Lead Quality
    • Add or Update Lead Stage
    • Add or Update Lead Channel
    • Add or Update Lead Type
    • Add or Update Lead Source
    • Add or Update Lead Note
  • Notifications
    • Company Endpoint
    • Contact Endpoint
    • CRM Endpoint
    • Invoice Endpoint
    • Booking Endpoint
    • Event Endpoint
  • Development Reference
    • Calculating md5
    • HMAC-SHA1
    • JSON Encoding
    • Timestamp Format
    • Date Format
    • Time Format
    • Address Format
    • URLEncoding
    • Timezone List
  • Announcements
    • Room Reservation Contact Changes
    • Contact Customfield Changes
    • Booking Accommodation API Changes
Powered by GitBook
On this page
  • Get Contact
  • Example Request
  • Returns
  • Status Options - Email Registration Status
  • Sms status
  • Custom Fields Keys
  • Event Invitations
  • Event Registrations Details
  • Invoice Details
  • External URL Field
  • Privacy Consent Data
  • Privacy Consent Source
  • Throws
  1. Contacts & Companies

Get Contact

Get Contact

POST [PlatformAddress]/api/1.0/contact?action=getContact

Get the contact details

Path Parameters

Name
Type
Description

id

integer

The contact's identifier

useEventSortOrder

boolean

If true, the eventInvitations and eventRegistrations will be returned ordered by Event Start Date

{
    "id": 7427530,
    "firstName": "Test",
    "lastName": "User",
    "email": "user@test.com",
    "phone": "0455550000",
    "status": 1,
    "smsStatus": 1,
    "customFields": [],
    "groups": [
        {
            "contactId": 7427530,
            "groupId": 57138,
            "joinDate": "2018-09-07 02:11:47"
        }
    ],
    "companies": [4, 5, 6],
    "companiesData":[
        {"id":4,"businessName":"Company Name 1"},
        {"id":5,"businessName":"Company Name 3 (Department)"},
        {"id":6,"businessName":"Company Name 2"},
    ],
    "externalId": null,
    "modifiedDate": "2018-09-07 02:11:47 UTC",
    "isAnonymised": false,
    "eventInvitations": [],
    "eventRegistrations": []
}

Example Request

This example request will obtain the details of the contact with the id "6"

{
  "id":6
}

Returns

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

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

isAnonymised

Whether or not contact data is annonymised

boolean

eventInvitations

array

eventRegistrations

array

externalUrls

array

privacyConsentData

object

Status Options - Email Registration Status

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

Sms status

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

Custom Fields Keys

Keys

fieldId

displayName

value

Event Invitations

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

Event Invitations Response values

#

Description

U

Undecided

Y

Yes

N

No

Event Registrations Details

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

Event Registration Status (currentStatus)

#

Description

2

Completed

3

Cancelled

4

Payment Required

Guest Details

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

Invoice Details

Property

Description

id

The unique identifier for the invoice

reference

The reference number of the invoice

title

The title of the invoice

currentStatus

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

Invoice current status

#

Description

0

Not Paid

1

Unconfirmed Paid

2

Written Off

3

Failed

4

Cancelled

5

Refunded

External URL Field

An External URL field is an object with the following details.

Property
Type
Description

ref

string

The unique reference key of the external URL

url

string

The url link (https) scheme eg. https://example.com

label

string

The label of the URL to display.

Privacy Consent Data

Property
Description

source

dateTime

The date time when the consent given

Privacy Consent Source

Source
Description

1

User Initiated Entry

2

Marketplace

3

Website Booking Engine

4

Event Website

5

API

Throws

Code

Description

Specific Code: 24096

Unable to find contact

The contact identifier must be provided to fetch a specific contact from the system.

PreviousGet Contact ListNextGet Contact Note List

Last updated 5 months ago

The contact's

The contact’s

The custom field information for the contact. This is an array of fields, each an object with the .

An array of events the contact has been invited to. Each element of the array is an object with

An array of events the contact has registered for. Each element of the array is an object with .

This is an array of field objects of the contact.

The object of field objects of the contact.

The contacts response to the invitation. .

An array of objects with

The list of invoices associated with the registration. Each element of the array is an object with

The current status of the invoice. The value of this field will be .

The result from this call will be a of all the events the user has access to. This call also accepts the and properties.

The of the consent

collection
pagination
filter
email status
sms status
keys
the event invitations fields
the event registration fields
ExternalUrl
Privacy Consent
List of response values
The status of the registration
the guest details.
the invoice fields.
one of the following current status
source