Get Company List

post
Get Company List

[PlatformAddress]/api/1.0/contact?action=getCompanyList
Get a list of companies
Request
Response
Path Parameters
perPage
required
integer
The number of companies to get in a single call
start
required
integer
The starting result of the page. Not 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 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

Keys

keys

line1

line2

line3

line4

city

stateCode (e.g: QLD)

countryCode (e.g: AU)

postalCode

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.