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

Returns a list of all companies you are partnered with

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiToken

Your API token

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Object

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"
    ]
  },
  {
    "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:
<Companies xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Company>
    <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>
  <Company>
    <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>
</Companies>