Reveal leads

Return the full data of the leads with the given ids (from POST /v1/directory/leads/search). Each revealed lead costs 0.5 credit. If the credit balance cannot cover all requested ids, only the first affordable leads are revealed and charged. When listId is provided, the revealed leads are also saved as contacts into that list (no extra credit cost): leads already in the workspace, excluded, or missing a first/last name are skipped. The save is synchronous, so a large reveal with listId can take noticeably longer — configure your HTTP client timeout accordingly.

POST

https://ext.gojiberry.ai

directory

leads

reveal

Reveal full leads (0.5 credit per lead)

curl --request POST \
  --url https://ext.gojiberry.ai/v1/directory/leads/reveal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    1234567890,
    987654321
  ],
  "listId": 123
}
'

import requests

url = "https://ext.gojiberry.ai/v1/directory/leads/reveal"

payload = {
    "ids": [1234567890, 987654321],
    "listId": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ids: [1234567890, 987654321], listId: 123})
};

fetch('https://ext.gojiberry.ai/v1/directory/leads/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://ext.gojiberry.ai/v1/directory/leads/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([
    'ids' => [
        1234567890,
        987654321
    ],
    'listId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://ext.gojiberry.ai/v1/directory/leads/reveal"

	payload := strings.NewReader("{\n  \"ids\": [\n    1234567890,\n    987654321\n  ],\n  \"listId\": 123\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://ext.gojiberry.ai/v1/directory/leads/reveal")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ids\": [\n    1234567890,\n    987654321\n  ],\n  \"listId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ext.gojiberry.ai/v1/directory/leads/reveal")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ids\": [\n    1234567890,\n    987654321\n  ],\n  \"listId\": 123\n}"

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

{
  "leads": [
    {}
  ],
  "requested": 123,
  "revealed": 123,
  "creditsUsed": 123,
  "savedToList": 123
}

Authorizations

Authorization

string

header

required

API key from Settings → API. Send it as Authorization: Bearer .

Headers

x-impersonate-user-id

string

ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.

Body

application/json

Ids of the leads to reveal (max 100 per request).

ids

number[]

required

Lead ids returned by the search endpoint

Example:

[1234567890, 987654321]

listId

number

Optional id of one of your lists. When provided, the revealed leads are also saved as contacts into this list (free of extra charge).

Example:

123

Response

Full leads and credit usage summary

leads

object[]

requested

number

Number of distinct ids requested

revealed

number

Number of leads actually returned

creditsUsed

number

savedToList

number

Only present when listId was provided: number of leads saved as contacts into the list (already-existing/excluded leads are skipped)

⌘I

Reveal full leads (0.5 credit per lead)

curl --request POST \
  --url https://ext.gojiberry.ai/v1/directory/leads/reveal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    1234567890,
    987654321
  ],
  "listId": 123
}
'

import requests

url = "https://ext.gojiberry.ai/v1/directory/leads/reveal"

payload = {
    "ids": [1234567890, 987654321],
    "listId": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ids: [1234567890, 987654321], listId: 123})
};

fetch('https://ext.gojiberry.ai/v1/directory/leads/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://ext.gojiberry.ai/v1/directory/leads/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([
    'ids' => [
        1234567890,
        987654321
    ],
    'listId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://ext.gojiberry.ai/v1/directory/leads/reveal"

	payload := strings.NewReader("{\n  \"ids\": [\n    1234567890,\n    987654321\n  ],\n  \"listId\": 123\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://ext.gojiberry.ai/v1/directory/leads/reveal")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ids\": [\n    1234567890,\n    987654321\n  ],\n  \"listId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ext.gojiberry.ai/v1/directory/leads/reveal")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ids\": [\n    1234567890,\n    987654321\n  ],\n  \"listId\": 123\n}"

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

{
  "leads": [
    {}
  ],
  "requested": 123,
  "revealed": 123,
  "creditsUsed": 123,
  "savedToList": 123
}

Getting Started

API reference

Reveal leads

Authorizations

Headers

Body

Response