Reveal Contact

curl --request POST \
  --url https://api.hirebase.org/v2/contacts/reveal \
  --header 'Content-Type: application/json' \
  --data '
{
  "linkedin_url": "<string>",
  "name": "<string>",
  "reveal_email": true,
  "reveal_phone": true
}
'

import requests

url = "https://api.hirebase.org/v2/contacts/reveal"

payload = {
    "linkedin_url": "<string>",
    "name": "<string>",
    "reveal_email": True,
    "reveal_phone": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    linkedin_url: '<string>',
    name: '<string>',
    reveal_email: true,
    reveal_phone: true
  })
};

fetch('https://api.hirebase.org/v2/contacts/reveal', 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://api.hirebase.org/v2/contacts/reveal",
  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([
    'linkedin_url' => '<string>',
    'name' => '<string>',
    'reveal_email' => true,
    'reveal_phone' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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://api.hirebase.org/v2/contacts/reveal"

	payload := strings.NewReader("{\n  \"linkedin_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"reveal_email\": true,\n  \"reveal_phone\": true\n}")

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

	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://api.hirebase.org/v2/contacts/reveal")
  .header("Content-Type", "application/json")
  .body("{\n  \"linkedin_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"reveal_email\": true,\n  \"reveal_phone\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hirebase.org/v2/contacts/reveal")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"linkedin_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"reveal_email\": true,\n  \"reveal_phone\": true\n}"

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

{
  "name": "<string>",
  "role": {},
  "profile_url": "<string>",
  "photo_url": {},
  "email": {},
  "email_status": {},
  "phone_number": {},
  "phone_numbers": {},
  "reveals": {}
}

POST

contacts

reveal

Reveal Contact

curl --request POST \
  --url https://api.hirebase.org/v2/contacts/reveal \
  --header 'Content-Type: application/json' \
  --data '
{
  "linkedin_url": "<string>",
  "name": "<string>",
  "reveal_email": true,
  "reveal_phone": true
}
'

import requests

url = "https://api.hirebase.org/v2/contacts/reveal"

payload = {
    "linkedin_url": "<string>",
    "name": "<string>",
    "reveal_email": True,
    "reveal_phone": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    linkedin_url: '<string>',
    name: '<string>',
    reveal_email: true,
    reveal_phone: true
  })
};

fetch('https://api.hirebase.org/v2/contacts/reveal', 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://api.hirebase.org/v2/contacts/reveal",
  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([
    'linkedin_url' => '<string>',
    'name' => '<string>',
    'reveal_email' => true,
    'reveal_phone' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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://api.hirebase.org/v2/contacts/reveal"

	payload := strings.NewReader("{\n  \"linkedin_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"reveal_email\": true,\n  \"reveal_phone\": true\n}")

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

	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://api.hirebase.org/v2/contacts/reveal")
  .header("Content-Type", "application/json")
  .body("{\n  \"linkedin_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"reveal_email\": true,\n  \"reveal_phone\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hirebase.org/v2/contacts/reveal")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"linkedin_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"reveal_email\": true,\n  \"reveal_phone\": true\n}"

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

{
  "name": "<string>",
  "role": {},
  "profile_url": "<string>",
  "photo_url": {},
  "email": {},
  "email_status": {},
  "phone_number": {},
  "phone_numbers": {},
  "reveals": {}
}

Enabled on request. Gated on the same hiring_manager_api feature as the Hiring Manager Contacts API; keys without it receive 403 with X-Billing-Code: feature_missing.

Billing. Settled when the task finishes: m_contact_email_reveals once if an email was found, m_contact_phone_reveals once if a phone number was found. Nothing is charged when nothing is found.

Turn a contact you already have (for example a row from a contacts result, or someone you found yourself) into a way to reach them. Submit the LinkedIn profile, then poll Task Status.

Request Body

string

required

The contact’s LinkedIn profile URL (linkedin.com/in/...), e.g. profile_url from a contacts result.

string

The contact’s name. Improves matching.

boolean

default:"true"

Return the work email when one is found.

boolean

default:"false"

Return a direct phone number (mobile preferred) when one is found. Typically adds one to three minutes. At least one of reveal_email / reveal_phone must be true.

Response

A task object (type: "enrich_contact"). When state is "finished", result holds:

string

string | null

string

string | null

Work email, when reveal_email was set and one was found.

string | null

e.g. verified, likely, unavailable.

string | null

E.164, mobile preferred, when reveal_phone was set and one was found.

object[] | null

Every number found: sanitized_number, type, status.

object

{ "email": 0 | 1, "phone": 0 | 1 } - what was found and billed.

Example

cURL

curl -X POST "https://api.hirebase.org/v2/contacts/reveal" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{ "linkedin_url": "https://www.linkedin.com/in/drew-bratcher-b8a9283a", "name": "Drew Bratcher", "reveal_email": true, "reveal_phone": true }'

Result (task.result when finished)

{
  "name": "Drew Bratcher",
  "role": "iOS Engineering Manager",
  "profile_url": "https://www.linkedin.com/in/drew-bratcher-b8a9283a",
  "photo_url": null,
  "email": "drew@example.com",
  "email_status": "verified",
  "phone_number": "+14155550158",
  "phone_numbers": [ { "sanitized_number": "+14155550158", "type": "mobile", "status": "valid_number" } ],
  "reveals": { "email": 1, "phone": 1 }
}

A task that ends "failed" with a “not found” error means no matching business profile exists for that LinkedIn URL; it is not charged. Personal emails and numbers are never returned.

Jobs API

Expired & Historical Jobs API

Hiring Manager API

Companies API

Insights API

Salary Benchmark API

Reference Data API

Resumes

Tasks API

Billing & Usage

Error Handling

Reveal Contact

Request Body

Response

Example

​Request Body

​Response

​Example

Request Body

Response

Example