iVvy Developer API
HomeSupportSystem StatusLogin
Search…
API Documentation
Getting Started
Contacts & Companies
Get Contact List
Get Contact
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
Add or Update Company
Add or Update Lead
Event
Venue
Partner
Invoice
Account
CRM
Development Reference
Powered By GitBook
Get Company List
post
[PlatformAddress]/api/1.0/contact?action=getCompanyList
Get Company List

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 company
externalId
Optionally a unique identifier of the company that is managed by an external application
businessName
The company's business name
tradingName
The company's trading name
businessNumber
The company's registration number
phone
The company's phone number
fax
The company's fax number
website
The company's website
email
The company's email address
address
The company’s address. This is an an object with the address keys.
modifiedDate
The modified date of the company
primaryAccountManager
The primary account manager of the company. This is an an object with the keys​
secondaryAccountManager
The secondary account manager of the company. This is an an object with the keys​
industry
The industry of the company. This is an an object with the keys​
primaryContact
The primary contact of the company. This is an an object with the keys​
commissionSpace
The commission amount of the company space.
commissionSpaceType
The commission amount type of the company space.
commissionFoodValue
The commission amount of the company food.
commissionFoodType
The commission amount type of the company food.
commissionBeverageValue
The commission amount of the company beverage.

Keys

keys
line1
line2
line3
line4
city
stateCode (e.g: QLD)
countryCode (e.g: AU)
postalCode

primarycontact

Property
Type
Description
id
integer
The unique identifier of the contact
firstName
string
The first name of the contact
lastName
string
The last name of the contact
email
string
The email address of the contact
phone
string
The phone number of the contact

primaryaccountmanager

Property
Type
Description
id
integer
The unique identifier of the primary account manager
firstName
string
The first name of the primary account manager
lastName
string
The last name of the primary account manager
email
string
The email address of the primary account manager

secondaryaccountmanager

Property
Type
Description
id
integer
The unique identifier of the secondary account manager
firstName
string
The first name of the secondary account manager
lastName
string
The last name of the secondary account manager
email
string
The email address of the secondary account manager

industry

Property
Type
Description
id
integer
The unique identifier of the industry
name
string
The name of the industry
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.
Previous
Remove Contacts From Subscription Group
Next
Get Company
Last modified 8mo ago
Copy link
Contents
post
Get Company List
Additional Filter Properties
Returns
Keys
primarycontact
primaryaccountmanager
secondaryaccountmanager
industry