GET company/{apiKey}/search?id={id}&email={email}&name={name}&page={page}&perPage={perPage}

Request Information

URI Parameters

Name	Type	Additional information
id	integer	Default value is 0
email	string	Default value is
name	string	Default value is
page	integer	Default value is 1
perPage	integer	Default value is 25
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"
}