GET v1/companies/{companyCode}?apiToken={apiToken}

Returns information about a specific company you are partnered with

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	The company code of the company you want to receive details for	string	Required
apiToken	Your API Token	string	None.

Body Parameters

None.

Response Information

Resource Description

CompanyResponse

Name	Type	Additional information
CompanyCode	string	None.
Name	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
City	string	None.
State	string	None.
Country	string	None.
ZipCode	string	None.
IsAgent	boolean	None.
IsThirdParty	boolean	None.
Categories	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "companyCode": "sample string 1",
  "name": "sample string 2",
  "addressLine1": "sample string 3",
  "addressLine2": "sample string 4",
  "city": "sample string 5",
  "state": "sample string 6",
  "country": "sample string 7",
  "zipCode": "sample string 8",
  "isAgent": true,
  "isThirdParty": true,
  "categories": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<Company xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CompanyCode>sample string 1</CompanyCode>
  <Name>sample string 2</Name>
  <AddressLine1>sample string 3</AddressLine1>
  <AddressLine2>sample string 4</AddressLine2>
  <City>sample string 5</City>
  <State>sample string 6</State>
  <Country>sample string 7</Country>
  <ZipCode>sample string 8</ZipCode>
  <IsAgent>true</IsAgent>
  <IsThirdParty>true</IsThirdParty>
  <Categories>
    <Category>sample string 1</Category>
    <Category>sample string 2</Category>
  </Categories>
</Company>