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 Company
  • Example Request
  • Returns
  • primarycontact
  • primaryaccountmanager
  • secondaryaccountmanager
  • industry
  • Custom Fields Keys
  • External URL Field
  • Throws
  1. Contacts & Companies

Get Company

Get Company

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

Get a single company's detail

Path Parameters

Name
Type
Description

id

integer

The company's identifier

{
  "id": "25146",
  "businessName": "Test",
  "tradingName": "Test Trading",
  "businessNumber": "1234586",
  "email": "company@test.com",
  "phone": "0455550000",
  "otherPhone": "123456789",
  "fax": "0455550125",
  "website": "www.test.com",
  "address": {
    "line1": "Street Number",
    "line2": "Street Name",
    "line3": "",
    "line4": "",
    "city": "Gold Coast",
    "stateCode": "QLD",
    "countryCode": "AU",
    "postalCode": "4227"
  },
  "customFields": [
      {
          "fieldId": 5,
          "displayName": "Birth Date",
          "value": "1985-03-17 23:00:00 UTC"
      }
  ],
  "primaryAccountManager": "Test User",
  "secondaryAccountManager": "Test User",
  "industry": "Industry Name",
  "primaryContact": "Test User",
  "commissionRoomHireValue": 123,
  "commissionRoomHireType": "CHF",
  "commissionFoodValue": 222,
  "commissionFoodType": "CHF",
  "commissionBeverageValue": 333,
  "commissionBeverageType": "CHF",
  "commissionAudioVisualValue": 444,
  "commissionAudioVisualType": "CHF",
  "commissionAccommodationValue": 555,
  "commissionAccommodationType": "CHF",
  "iataNumber": "123456789"
}

Example Request

Get a specific company

{
  "id":6
}

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

otherPhone

The company's other phone number

fax

The company's fax number

website

The company's website

email

The company's email address

address

modifiedDate

The modified date of the company

primaryAccountManager

secondaryAccountManager

industry

primaryContact

isAgent

Whether the company is an agent or not.

parentCompanyId

The parent company id of the company

leftValue

The left value of the node in the tree structure.

rightValue

The right value of the node in the tree structure.

depth

The depth of this company in the tree structure.

rootId

The root company id.

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.

commissionBeverageType

The commission amount type of the company beverage.

commissionAudioVisualValue

The commission amount of the company audio visual.

commissionAudioVisualType

The commission amount type of the company audio visual.

commissionAccommodationValue

The commission amount of the company accommodation.

commissionAccommodationType

The commission amount type of the accommodation.

iataNumber

The IATA number of commission payable to the agent.

customFields

externalUrls

## 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

Custom Fields Keys

| fieldId | | displayName | | value |

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.

Throws

Code
Description

Specific Code: 24153

Unable to find company

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

PreviousGet Company ListNextGet Company Note List

Last updated 7 months ago

The company’s address. This is an an object with the

The primary account manager of the company. This is an an object with the

The secondary account manager of the company. This is an an object with the

The industry of the company. This is an an object with the

The primary contact of the company. This is an an object with the

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

This is an array of field objects of the company.

keys
keys
keys
keys
keys
keys
ExternalUrl