GET companies/{apiKey}/search?email={email}

Request Information

URI Parameters

Name	Description	Type	Additional information
email		string	Required
apiKey		string	None.

Body Parameters

None.

Response Information

Resource Description

CompanySearchResult

Name	Type	Additional information
total_results	integer	None.
current_page	integer	None.
per_page	integer	None.
starting	integer	None.
companies	Collection of TPICompany	None.
status	string	None.
request_length	decimal number	None.
message	string	None.
ipaddress	string	None.

Response Formats

application/json, text/json

Sample:

{
  "total_results": 1,
  "current_page": 2,
  "per_page": 3,
  "starting": 4,
  "companies": [
    {
      "id": 1,
      "name": "sample string 2",
      "website_url": "sample string 3",
      "email": "sample string 4",
      "addresses": [
        {
          "address_line_1": "sample string 1",
          "city": "sample string 2",
          "district": "sample string 3",
          "country": "sample string 4",
          "post_code": "sample string 5",
          "address_type": "sample string 6"
        },
        {
          "address_line_1": "sample string 1",
          "city": "sample string 2",
          "district": "sample string 3",
          "country": "sample string 4",
          "post_code": "sample string 5",
          "address_type": "sample string 6"
        }
      ],
      "phone_numbers": [
        {
          "phone_number": "sample string 1",
          "phone_type": "sample string 2"
        },
        {
          "phone_number": "sample string 1",
          "phone_type": "sample string 2"
        }
      ]
    },
    {
      "id": 1,
      "name": "sample string 2",
      "website_url": "sample string 3",
      "email": "sample string 4",
      "addresses": [
        {
          "address_line_1": "sample string 1",
          "city": "sample string 2",
          "district": "sample string 3",
          "country": "sample string 4",
          "post_code": "sample string 5",
          "address_type": "sample string 6"
        },
        {
          "address_line_1": "sample string 1",
          "city": "sample string 2",
          "district": "sample string 3",
          "country": "sample string 4",
          "post_code": "sample string 5",
          "address_type": "sample string 6"
        }
      ],
      "phone_numbers": [
        {
          "phone_number": "sample string 1",
          "phone_type": "sample string 2"
        },
        {
          "phone_number": "sample string 1",
          "phone_type": "sample string 2"
        }
      ]
    }
  ],
  "status": "sample string 5",
  "request_length": 6.1,
  "message": "sample string 7",
  "ipaddress": "sample string 8"
}

text/xml

Sample:

<company_search_result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">
  <ipaddress>sample string 8</ipaddress>
  <message>sample string 7</message>
  <request_length>6.1</request_length>
  <status>sample string 5</status>
  <companies>
    <company>
      <addresses>
        <company_address>
          <address_line_1>sample string 1</address_line_1>
          <address_type>sample string 6</address_type>
          <city>sample string 2</city>
          <country>sample string 4</country>
          <district>sample string 3</district>
          <post_code>sample string 5</post_code>
        </company_address>
        <company_address>
          <address_line_1>sample string 1</address_line_1>
          <address_type>sample string 6</address_type>
          <city>sample string 2</city>
          <country>sample string 4</country>
          <district>sample string 3</district>
          <post_code>sample string 5</post_code>
        </company_address>
      </addresses>
      <email>sample string 4</email>
      <id>1</id>
      <name>sample string 2</name>
      <phone_numbers>
        <company_phone>
          <phone_number>sample string 1</phone_number>
          <phone_type>sample string 2</phone_type>
        </company_phone>
        <company_phone>
          <phone_number>sample string 1</phone_number>
          <phone_type>sample string 2</phone_type>
        </company_phone>
      </phone_numbers>
      <website_url>sample string 3</website_url>
    </company>
    <company>
      <addresses>
        <company_address>
          <address_line_1>sample string 1</address_line_1>
          <address_type>sample string 6</address_type>
          <city>sample string 2</city>
          <country>sample string 4</country>
          <district>sample string 3</district>
          <post_code>sample string 5</post_code>
        </company_address>
        <company_address>
          <address_line_1>sample string 1</address_line_1>
          <address_type>sample string 6</address_type>
          <city>sample string 2</city>
          <country>sample string 4</country>
          <district>sample string 3</district>
          <post_code>sample string 5</post_code>
        </company_address>
      </addresses>
      <email>sample string 4</email>
      <id>1</id>
      <name>sample string 2</name>
      <phone_numbers>
        <company_phone>
          <phone_number>sample string 1</phone_number>
          <phone_type>sample string 2</phone_type>
        </company_phone>
        <company_phone>
          <phone_number>sample string 1</phone_number>
          <phone_type>sample string 2</phone_type>
        </company_phone>
      </phone_numbers>
      <website_url>sample string 3</website_url>
    </company>
  </companies>
  <current_page>2</current_page>
  <per_page>3</per_page>
  <starting>4</starting>
  <total_results>1</total_results>
</company_search_result>