Batch lookup companies

Each entry in queries is resolved independently using the same matching semantics as GET /v1/companies/lookup. Results are returned in the same order as the input.

POST /v1/companies/lookup/batch

Look up multiple companies in a single request.

cURL

curl --request POST \
  --url https://production-api.joinrings.com/v1/companies/lookup/batch \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "queries": [
    {
      "domain": "<string>",
      "limit": 5,
      "linkedin_url": "<string>",
      "name": "<string>"
    }
  ]
}
'

import requests

url = "https://production-api.joinrings.com/v1/companies/lookup/batch"

payload = { "queries": [
        {
            "domain": "<string>",
            "limit": 5,
            "linkedin_url": "<string>",
            "name": "<string>"
        }
    ] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    queries: [{domain: '<string>', limit: 5, linkedin_url: '<string>', name: '<string>'}]
  })
};

fetch('https://production-api.joinrings.com/v1/companies/lookup/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://production-api.joinrings.com/v1/companies/lookup/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'queries' => [
        [
                'domain' => '<string>',
                'limit' => 5,
                'linkedin_url' => '<string>',
                'name' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://production-api.joinrings.com/v1/companies/lookup/batch"

	payload := strings.NewReader("{\n  \"queries\": [\n    {\n      \"domain\": \"<string>\",\n      \"limit\": 5,\n      \"linkedin_url\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://production-api.joinrings.com/v1/companies/lookup/batch")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"queries\": [\n    {\n      \"domain\": \"<string>\",\n      \"limit\": 5,\n      \"linkedin_url\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production-api.joinrings.com/v1/companies/lookup/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"queries\": [\n    {\n      \"domain\": \"<string>\",\n      \"limit\": 5,\n      \"linkedin_url\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "results": [
    {
      "count": 123,
      "matches": [
        {
          "last_activity_date": "<string>",
          "linkedin_url": "<string>",
          "name": "<string>",
          "uuid": "<string>",
          "website": "<string>",
          "city": "<string>",
          "country_code": "<string>",
          "description": "<string>",
          "entity_lists": [
            {
              "name": "<string>",
              "uuid": "<string>"
            }
          ],
          "last_contact_at": "<string>",
          "logo_url": "<string>",
          "pathpower": {
            "meta": {},
            "score": 123,
            "strength_label": "<string>"
          },
          "rings_industry_tags": [
            "<string>"
          ],
          "state": "<string>"
        }
      ],
      "query": {
        "domain": "<string>",
        "limit": 5,
        "linkedin_url": "<string>",
        "name": "<string>"
      }
    }
  ]
}

Authorizations

x-api-key · string · header · required

Body

application/json

queries · CompanyLookupBatchItem · object[] · required

Show child attributes

Response

200 - application/json

Batch lookup response, ordered to match the input queries.

results · CompanyLookupBatchResult · object[] · required

Show child attributes