Get Company

post
Get Company

[PlatformAddress]/api/1.0/contact?action=getCompany
Get a single company's detail
Request
Response
Path Parameters
id
required
integer
The company's identifier
200: OK
{
"id": "25146",
"businessName": "Test",
"tradingName": "Test Trading",
"businessNumber": "1234586",
"email": "company@test.com",
"phone": "0455550000",
"fax": "0455550125",
"website": "www.test.com",
"address": {
"line1": "Street Number",
"line2": "Street Name",
"line3": "",
"line4": "",
"city": "Gold Coast",
"stateCode": "QLD",
"countryCode": "AU",
"postalCode": "4227"
}
}

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

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 keys

modifiedDate

The modified date of the company

Keys

keys

line1

line2

line3

line4

city

stateCode (e.g: QLD)

countryCode (e.g: AU)

postalCode

Throws

Code

Description

Specific Code: 24153

Unable to find company

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