Get Contact List

Last updated 8 months ago

post
Get Contact List
[PlatformAddress]/api/1.0/contact?action=getContactList
Get Contact List will respond with a list of contacts based on the filter parameters
Request
Response
Path Parameters
perPage
required
integer
The number of events to get in a single api call
start
required
integer
The starting result of the page. Note this is zero based (i.e. sending start = 0 will start from the first result.)
200: OK
​
Additional Filter Properties
Property
Description
Type
fromModifiedDate
Filter by Modified Date
​iVvy Timestamp Format​
toModifiedDate
Filter by Modified Date
​iVvy Timestamp Format​
venueId
Filter by specific Venue
integer
venueGroupId
Filter by SPecific Venue Group
integer
Returns
Property
Description
id
The unique identifier for the contact
firstName
The contact’s first name
lastName
The contact’s last name
email
The contact’s email address
phone
The contact’s phone number
customFields
The custom field information for the contact. This is an array of fields, each an object with the keys.
groups
The subscription group information for the contact.
companies
This will an array company ids to which the contact belongs.
externalId
This will be external id of the contact
modifiedDate
The modified date of the contact
keys
fieldId
displayName
value
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.

Contacts & Companies

Get Contact

Property	Description	Type
fromModifiedDate	Filter by Modified Date	iVvy Timestamp Format
toModifiedDate	Filter by Modified Date	iVvy Timestamp Format
venueId	Filter by specific Venue	integer
venueGroupId	Filter by SPecific Venue Group	integer

Property	Description
id	The unique identifier for the contact
firstName	The contact’s first name
lastName	The contact’s last name
email	The contact’s email address
phone	The contact’s phone number
customFields	The custom field information for the contact. This is an array of fields, each an object with the keys.
groups	The subscription group information for the contact.
companies	This will an array company ids to which the contact belongs.
externalId	This will be external id of the contact
modifiedDate	The modified date of the contact

Get Contact List

postGet Contact List

Additional Filter Properties

Returns

keys

post
Get Contact List