curl --request GET \
--url https://api.tamtam.ai/api/v2/contact-searches/{searchID} \
--header 'Authorization: <api-key>'import requests
url = "https://api.tamtam.ai/api/v2/contact-searches/{searchID}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.tamtam.ai/api/v2/contact-searches/{searchID}', 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.tamtam.ai/api/v2/contact-searches/{searchID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.tamtam.ai/api/v2/contact-searches/{searchID}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tamtam.ai/api/v2/contact-searches/{searchID}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tamtam.ai/api/v2/contact-searches/{searchID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"company_linkedin_ids": [
"<string>"
],
"contacts_list_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_email": "<string>",
"id": "<string>",
"name": "<string>",
"queries": [
{
"include_past_job_titles": true,
"label": "<string>",
"canonical_job_titles_excludes_ids": [
"<string>"
],
"canonical_job_titles_includes_ids": [
"<string>"
],
"countries": [
"<string>"
],
"country_excludes": [
"<string>"
],
"job_titles_excludes": [
"<string>"
],
"job_titles_includes": [
"<string>"
],
"keywords": "<string>",
"persona_id": "<string>",
"seniority_excludes": [
"<string>"
],
"seniority_includes": [
"<string>"
]
}
],
"status": {
"cancelled_jobs": 123,
"companies_searched": 123,
"contacts_in_list_count": 123,
"done_jobs": 123,
"phase": "Searching",
"skipped_deleted_company_jobs": 123,
"total_jobs": 123,
"total_processed_results": 123,
"empty_reason": "<string>"
},
"already_existed": true
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Get a contact search
The search as submitted, plus how far it has got. Poll this while status.phase is Searching.
status.contacts_in_list_count is the number of people found so far, deduplicated; status.total_jobs and status.done_jobs are progress. When a finished search found nobody, status.empty_reason says which of the several causes it was.
curl --request GET \
--url https://api.tamtam.ai/api/v2/contact-searches/{searchID} \
--header 'Authorization: <api-key>'import requests
url = "https://api.tamtam.ai/api/v2/contact-searches/{searchID}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.tamtam.ai/api/v2/contact-searches/{searchID}', 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.tamtam.ai/api/v2/contact-searches/{searchID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.tamtam.ai/api/v2/contact-searches/{searchID}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tamtam.ai/api/v2/contact-searches/{searchID}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tamtam.ai/api/v2/contact-searches/{searchID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"company_linkedin_ids": [
"<string>"
],
"contacts_list_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by_user_email": "<string>",
"id": "<string>",
"name": "<string>",
"queries": [
{
"include_past_job_titles": true,
"label": "<string>",
"canonical_job_titles_excludes_ids": [
"<string>"
],
"canonical_job_titles_includes_ids": [
"<string>"
],
"countries": [
"<string>"
],
"country_excludes": [
"<string>"
],
"job_titles_excludes": [
"<string>"
],
"job_titles_includes": [
"<string>"
],
"keywords": "<string>",
"persona_id": "<string>",
"seniority_excludes": [
"<string>"
],
"seniority_includes": [
"<string>"
]
}
],
"status": {
"cancelled_jobs": 123,
"companies_searched": 123,
"contacts_in_list_count": 123,
"done_jobs": 123,
"phase": "Searching",
"skipped_deleted_company_jobs": 123,
"total_jobs": 123,
"total_processed_results": 123,
"empty_reason": "<string>"
},
"already_existed": true
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Authorizations
Account API key passed in the Authorization header
Path Parameters
Contact search UUID, as returned by Start a contact search. Not the contacts list's id — see contacts_list_id.
Response
OK
The contacts list this search delivers into. This is the id to read results with — List the contacts in a contacts list — and several searches may share one.
Whatever user_email the submission carried; empty when it carried none.
The SEARCH's id. Pass it to the status and stop operations.
Derived at submit time from the queries and companies, e.g. 'Revenue leadership @ Acme, Globex and 3 others'.
The queries as submitted, frozen. A persona edited since does not change them.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Only on a create: true when your idempotency_key matched a submission already in flight, so this is that search rather than a new one.