Person role search totals
curl --request POST \
--url https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/ \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"page": 123,
"role_title": "<string>",
"role_description": "<string>",
"role_is_current": true,
"role_position_start_date": "2023-12-25",
"role_position_end_date": "2023-12-25",
"role_years_on_position_start": 123,
"role_years_on_position_end": 123,
"person_name": "<string>",
"person_headline": "<string>",
"person_description": "<string>",
"person_skills": [
123
],
"person_locations": [
123
],
"person_industries": [
123
],
"person_industries_exclude": [
123
],
"person_linkedin_public_identifiers": [
"<string>"
],
"organizations": [
123
],
"organizations_bulk_domain": "<string>",
"organization_domains": [
"<string>"
],
"organization_description": "<string>",
"organization_locations": [
123
],
"organization_industries": [
123
],
"organization_industries_exclude": [
123
],
"organization_keywords": [
123
],
"organization_web_technologies": [
123
],
"organization_founded_date_start": "2023-12-25",
"organization_founded_date_end": "2023-12-25",
"organization_employees_start": 123,
"organization_employees_end": 123,
"organization_revenue_start": 123,
"organization_revenue_end": 123,
"organization_domain_rank_start": 123,
"organization_domain_rank_end": 123,
"organization_linkedin_public_identifiers": [
"<string>"
],
"funding_types": [],
"funding_total_start": 123,
"funding_total_end": 123,
"funding_event_date_featured_start": "2023-12-25",
"funding_event_date_featured_end": "2023-12-25",
"job_post_title": "<string>",
"job_post_description": "<string>",
"job_post_is_remote": true,
"job_post_is_active": true,
"job_post_date_featured_start": "2023-12-25",
"job_post_date_featured_end": "2023-12-25",
"job_post_locations": [
123
],
"job_post_locations_exclude": [
123
],
"simple_event_date_featured_start": "2023-12-25",
"simple_event_date_featured_end": "2023-12-25"
}
'import requests
url = "https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/"
payload = {
"page": 123,
"role_title": "<string>",
"role_description": "<string>",
"role_is_current": True,
"role_position_start_date": "2023-12-25",
"role_position_end_date": "2023-12-25",
"role_years_on_position_start": 123,
"role_years_on_position_end": 123,
"person_name": "<string>",
"person_headline": "<string>",
"person_description": "<string>",
"person_skills": [123],
"person_locations": [123],
"person_industries": [123],
"person_industries_exclude": [123],
"person_linkedin_public_identifiers": ["<string>"],
"organizations": [123],
"organizations_bulk_domain": "<string>",
"organization_domains": ["<string>"],
"organization_description": "<string>",
"organization_locations": [123],
"organization_industries": [123],
"organization_industries_exclude": [123],
"organization_keywords": [123],
"organization_web_technologies": [123],
"organization_founded_date_start": "2023-12-25",
"organization_founded_date_end": "2023-12-25",
"organization_employees_start": 123,
"organization_employees_end": 123,
"organization_revenue_start": 123,
"organization_revenue_end": 123,
"organization_domain_rank_start": 123,
"organization_domain_rank_end": 123,
"organization_linkedin_public_identifiers": ["<string>"],
"funding_types": [],
"funding_total_start": 123,
"funding_total_end": 123,
"funding_event_date_featured_start": "2023-12-25",
"funding_event_date_featured_end": "2023-12-25",
"job_post_title": "<string>",
"job_post_description": "<string>",
"job_post_is_remote": True,
"job_post_is_active": True,
"job_post_date_featured_start": "2023-12-25",
"job_post_date_featured_end": "2023-12-25",
"job_post_locations": [123],
"job_post_locations_exclude": [123],
"simple_event_date_featured_start": "2023-12-25",
"simple_event_date_featured_end": "2023-12-25"
}
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({
page: 123,
role_title: '<string>',
role_description: '<string>',
role_is_current: true,
role_position_start_date: '2023-12-25',
role_position_end_date: '2023-12-25',
role_years_on_position_start: 123,
role_years_on_position_end: 123,
person_name: '<string>',
person_headline: '<string>',
person_description: '<string>',
person_skills: [123],
person_locations: [123],
person_industries: [123],
person_industries_exclude: [123],
person_linkedin_public_identifiers: ['<string>'],
organizations: [123],
organizations_bulk_domain: '<string>',
organization_domains: ['<string>'],
organization_description: '<string>',
organization_locations: [123],
organization_industries: [123],
organization_industries_exclude: [123],
organization_keywords: [123],
organization_web_technologies: [123],
organization_founded_date_start: '2023-12-25',
organization_founded_date_end: '2023-12-25',
organization_employees_start: 123,
organization_employees_end: 123,
organization_revenue_start: 123,
organization_revenue_end: 123,
organization_domain_rank_start: 123,
organization_domain_rank_end: 123,
organization_linkedin_public_identifiers: ['<string>'],
funding_types: [],
funding_total_start: 123,
funding_total_end: 123,
funding_event_date_featured_start: '2023-12-25',
funding_event_date_featured_end: '2023-12-25',
job_post_title: '<string>',
job_post_description: '<string>',
job_post_is_remote: true,
job_post_is_active: true,
job_post_date_featured_start: '2023-12-25',
job_post_date_featured_end: '2023-12-25',
job_post_locations: [123],
job_post_locations_exclude: [123],
simple_event_date_featured_start: '2023-12-25',
simple_event_date_featured_end: '2023-12-25'
})
};
fetch('https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
page: 123,
role_title: '<string>',
role_description: '<string>',
role_is_current: true,
role_position_start_date: '2023-12-25',
role_position_end_date: '2023-12-25',
role_years_on_position_start: 123,
role_years_on_position_end: 123,
person_name: '<string>',
person_headline: '<string>',
person_description: '<string>',
person_skills: [123],
person_locations: [123],
person_industries: [123],
person_industries_exclude: [123],
person_linkedin_public_identifiers: ['<string>'],
organizations: [123],
organizations_bulk_domain: '<string>',
organization_domains: ['<string>'],
organization_description: '<string>',
organization_locations: [123],
organization_industries: [123],
organization_industries_exclude: [123],
organization_keywords: [123],
organization_web_technologies: [123],
organization_founded_date_start: '2023-12-25',
organization_founded_date_end: '2023-12-25',
organization_employees_start: 123,
organization_employees_end: 123,
organization_revenue_start: 123,
organization_revenue_end: 123,
organization_domain_rank_start: 123,
organization_domain_rank_end: 123,
organization_linkedin_public_identifiers: ['<string>'],
funding_types: [],
funding_total_start: 123,
funding_total_end: 123,
funding_event_date_featured_start: '2023-12-25',
funding_event_date_featured_end: '2023-12-25',
job_post_title: '<string>',
job_post_description: '<string>',
job_post_is_remote: true,
job_post_is_active: true,
job_post_date_featured_start: '2023-12-25',
job_post_date_featured_end: '2023-12-25',
job_post_locations: [123],
job_post_locations_exclude: [123],
simple_event_date_featured_start: '2023-12-25',
simple_event_date_featured_end: '2023-12-25'
})
};
fetch('https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/"
payload := strings.NewReader("{\n \"page\": 123,\n \"role_title\": \"<string>\",\n \"role_description\": \"<string>\",\n \"role_is_current\": true,\n \"role_position_start_date\": \"2023-12-25\",\n \"role_position_end_date\": \"2023-12-25\",\n \"role_years_on_position_start\": 123,\n \"role_years_on_position_end\": 123,\n \"person_name\": \"<string>\",\n \"person_headline\": \"<string>\",\n \"person_description\": \"<string>\",\n \"person_skills\": [\n 123\n ],\n \"person_locations\": [\n 123\n ],\n \"person_industries\": [\n 123\n ],\n \"person_industries_exclude\": [\n 123\n ],\n \"person_linkedin_public_identifiers\": [\n \"<string>\"\n ],\n \"organizations\": [\n 123\n ],\n \"organizations_bulk_domain\": \"<string>\",\n \"organization_domains\": [\n \"<string>\"\n ],\n \"organization_description\": \"<string>\",\n \"organization_locations\": [\n 123\n ],\n \"organization_industries\": [\n 123\n ],\n \"organization_industries_exclude\": [\n 123\n ],\n \"organization_keywords\": [\n 123\n ],\n \"organization_web_technologies\": [\n 123\n ],\n \"organization_founded_date_start\": \"2023-12-25\",\n \"organization_founded_date_end\": \"2023-12-25\",\n \"organization_employees_start\": 123,\n \"organization_employees_end\": 123,\n \"organization_revenue_start\": 123,\n \"organization_revenue_end\": 123,\n \"organization_domain_rank_start\": 123,\n \"organization_domain_rank_end\": 123,\n \"organization_linkedin_public_identifiers\": [\n \"<string>\"\n ],\n \"funding_types\": [],\n \"funding_total_start\": 123,\n \"funding_total_end\": 123,\n \"funding_event_date_featured_start\": \"2023-12-25\",\n \"funding_event_date_featured_end\": \"2023-12-25\",\n \"job_post_title\": \"<string>\",\n \"job_post_description\": \"<string>\",\n \"job_post_is_remote\": true,\n \"job_post_is_active\": true,\n \"job_post_date_featured_start\": \"2023-12-25\",\n \"job_post_date_featured_end\": \"2023-12-25\",\n \"job_post_locations\": [\n 123\n ],\n \"job_post_locations_exclude\": [\n 123\n ],\n \"simple_event_date_featured_start\": \"2023-12-25\",\n \"simple_event_date_featured_end\": \"2023-12-25\"\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))
}require 'uri'
require 'net/http'
url = URI("https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/")
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 \"page\": 123,\n \"role_title\": \"<string>\",\n \"role_description\": \"<string>\",\n \"role_is_current\": true,\n \"role_position_start_date\": \"2023-12-25\",\n \"role_position_end_date\": \"2023-12-25\",\n \"role_years_on_position_start\": 123,\n \"role_years_on_position_end\": 123,\n \"person_name\": \"<string>\",\n \"person_headline\": \"<string>\",\n \"person_description\": \"<string>\",\n \"person_skills\": [\n 123\n ],\n \"person_locations\": [\n 123\n ],\n \"person_industries\": [\n 123\n ],\n \"person_industries_exclude\": [\n 123\n ],\n \"person_linkedin_public_identifiers\": [\n \"<string>\"\n ],\n \"organizations\": [\n 123\n ],\n \"organizations_bulk_domain\": \"<string>\",\n \"organization_domains\": [\n \"<string>\"\n ],\n \"organization_description\": \"<string>\",\n \"organization_locations\": [\n 123\n ],\n \"organization_industries\": [\n 123\n ],\n \"organization_industries_exclude\": [\n 123\n ],\n \"organization_keywords\": [\n 123\n ],\n \"organization_web_technologies\": [\n 123\n ],\n \"organization_founded_date_start\": \"2023-12-25\",\n \"organization_founded_date_end\": \"2023-12-25\",\n \"organization_employees_start\": 123,\n \"organization_employees_end\": 123,\n \"organization_revenue_start\": 123,\n \"organization_revenue_end\": 123,\n \"organization_domain_rank_start\": 123,\n \"organization_domain_rank_end\": 123,\n \"organization_linkedin_public_identifiers\": [\n \"<string>\"\n ],\n \"funding_types\": [],\n \"funding_total_start\": 123,\n \"funding_total_end\": 123,\n \"funding_event_date_featured_start\": \"2023-12-25\",\n \"funding_event_date_featured_end\": \"2023-12-25\",\n \"job_post_title\": \"<string>\",\n \"job_post_description\": \"<string>\",\n \"job_post_is_remote\": true,\n \"job_post_is_active\": true,\n \"job_post_date_featured_start\": \"2023-12-25\",\n \"job_post_date_featured_end\": \"2023-12-25\",\n \"job_post_locations\": [\n 123\n ],\n \"job_post_locations_exclude\": [\n 123\n ],\n \"simple_event_date_featured_start\": \"2023-12-25\",\n \"simple_event_date_featured_end\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/",
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([
'page' => 123,
'role_title' => '<string>',
'role_description' => '<string>',
'role_is_current' => true,
'role_position_start_date' => '2023-12-25',
'role_position_end_date' => '2023-12-25',
'role_years_on_position_start' => 123,
'role_years_on_position_end' => 123,
'person_name' => '<string>',
'person_headline' => '<string>',
'person_description' => '<string>',
'person_skills' => [
123
],
'person_locations' => [
123
],
'person_industries' => [
123
],
'person_industries_exclude' => [
123
],
'person_linkedin_public_identifiers' => [
'<string>'
],
'organizations' => [
123
],
'organizations_bulk_domain' => '<string>',
'organization_domains' => [
'<string>'
],
'organization_description' => '<string>',
'organization_locations' => [
123
],
'organization_industries' => [
123
],
'organization_industries_exclude' => [
123
],
'organization_keywords' => [
123
],
'organization_web_technologies' => [
123
],
'organization_founded_date_start' => '2023-12-25',
'organization_founded_date_end' => '2023-12-25',
'organization_employees_start' => 123,
'organization_employees_end' => 123,
'organization_revenue_start' => 123,
'organization_revenue_end' => 123,
'organization_domain_rank_start' => 123,
'organization_domain_rank_end' => 123,
'organization_linkedin_public_identifiers' => [
'<string>'
],
'funding_types' => [
],
'funding_total_start' => 123,
'funding_total_end' => 123,
'funding_event_date_featured_start' => '2023-12-25',
'funding_event_date_featured_end' => '2023-12-25',
'job_post_title' => '<string>',
'job_post_description' => '<string>',
'job_post_is_remote' => true,
'job_post_is_active' => true,
'job_post_date_featured_start' => '2023-12-25',
'job_post_date_featured_end' => '2023-12-25',
'job_post_locations' => [
123
],
'job_post_locations_exclude' => [
123
],
'simple_event_date_featured_start' => '2023-12-25',
'simple_event_date_featured_end' => '2023-12-25'
]),
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;
}HttpResponse<String> response = Unirest.post("https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"page\": 123,\n \"role_title\": \"<string>\",\n \"role_description\": \"<string>\",\n \"role_is_current\": true,\n \"role_position_start_date\": \"2023-12-25\",\n \"role_position_end_date\": \"2023-12-25\",\n \"role_years_on_position_start\": 123,\n \"role_years_on_position_end\": 123,\n \"person_name\": \"<string>\",\n \"person_headline\": \"<string>\",\n \"person_description\": \"<string>\",\n \"person_skills\": [\n 123\n ],\n \"person_locations\": [\n 123\n ],\n \"person_industries\": [\n 123\n ],\n \"person_industries_exclude\": [\n 123\n ],\n \"person_linkedin_public_identifiers\": [\n \"<string>\"\n ],\n \"organizations\": [\n 123\n ],\n \"organizations_bulk_domain\": \"<string>\",\n \"organization_domains\": [\n \"<string>\"\n ],\n \"organization_description\": \"<string>\",\n \"organization_locations\": [\n 123\n ],\n \"organization_industries\": [\n 123\n ],\n \"organization_industries_exclude\": [\n 123\n ],\n \"organization_keywords\": [\n 123\n ],\n \"organization_web_technologies\": [\n 123\n ],\n \"organization_founded_date_start\": \"2023-12-25\",\n \"organization_founded_date_end\": \"2023-12-25\",\n \"organization_employees_start\": 123,\n \"organization_employees_end\": 123,\n \"organization_revenue_start\": 123,\n \"organization_revenue_end\": 123,\n \"organization_domain_rank_start\": 123,\n \"organization_domain_rank_end\": 123,\n \"organization_linkedin_public_identifiers\": [\n \"<string>\"\n ],\n \"funding_types\": [],\n \"funding_total_start\": 123,\n \"funding_total_end\": 123,\n \"funding_event_date_featured_start\": \"2023-12-25\",\n \"funding_event_date_featured_end\": \"2023-12-25\",\n \"job_post_title\": \"<string>\",\n \"job_post_description\": \"<string>\",\n \"job_post_is_remote\": true,\n \"job_post_is_active\": true,\n \"job_post_date_featured_start\": \"2023-12-25\",\n \"job_post_date_featured_end\": \"2023-12-25\",\n \"job_post_locations\": [\n 123\n ],\n \"job_post_locations_exclude\": [\n 123\n ],\n \"simple_event_date_featured_start\": \"2023-12-25\",\n \"simple_event_date_featured_end\": \"2023-12-25\"\n}")
.asString();{
"total_search_results": 1,
"total_persons": 1,
"total_organizations": 1
}{
"detail": "Authentication credentials were not provided."
}People search API: result totals
Get the total number of matches for a person role search.
POST
https://api-v2.forager.ai
/
api
/
{account_id}
/
datastorage
/
person_role_search
/
totals
/
Person role search totals
curl --request POST \
--url https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/ \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"page": 123,
"role_title": "<string>",
"role_description": "<string>",
"role_is_current": true,
"role_position_start_date": "2023-12-25",
"role_position_end_date": "2023-12-25",
"role_years_on_position_start": 123,
"role_years_on_position_end": 123,
"person_name": "<string>",
"person_headline": "<string>",
"person_description": "<string>",
"person_skills": [
123
],
"person_locations": [
123
],
"person_industries": [
123
],
"person_industries_exclude": [
123
],
"person_linkedin_public_identifiers": [
"<string>"
],
"organizations": [
123
],
"organizations_bulk_domain": "<string>",
"organization_domains": [
"<string>"
],
"organization_description": "<string>",
"organization_locations": [
123
],
"organization_industries": [
123
],
"organization_industries_exclude": [
123
],
"organization_keywords": [
123
],
"organization_web_technologies": [
123
],
"organization_founded_date_start": "2023-12-25",
"organization_founded_date_end": "2023-12-25",
"organization_employees_start": 123,
"organization_employees_end": 123,
"organization_revenue_start": 123,
"organization_revenue_end": 123,
"organization_domain_rank_start": 123,
"organization_domain_rank_end": 123,
"organization_linkedin_public_identifiers": [
"<string>"
],
"funding_types": [],
"funding_total_start": 123,
"funding_total_end": 123,
"funding_event_date_featured_start": "2023-12-25",
"funding_event_date_featured_end": "2023-12-25",
"job_post_title": "<string>",
"job_post_description": "<string>",
"job_post_is_remote": true,
"job_post_is_active": true,
"job_post_date_featured_start": "2023-12-25",
"job_post_date_featured_end": "2023-12-25",
"job_post_locations": [
123
],
"job_post_locations_exclude": [
123
],
"simple_event_date_featured_start": "2023-12-25",
"simple_event_date_featured_end": "2023-12-25"
}
'import requests
url = "https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/"
payload = {
"page": 123,
"role_title": "<string>",
"role_description": "<string>",
"role_is_current": True,
"role_position_start_date": "2023-12-25",
"role_position_end_date": "2023-12-25",
"role_years_on_position_start": 123,
"role_years_on_position_end": 123,
"person_name": "<string>",
"person_headline": "<string>",
"person_description": "<string>",
"person_skills": [123],
"person_locations": [123],
"person_industries": [123],
"person_industries_exclude": [123],
"person_linkedin_public_identifiers": ["<string>"],
"organizations": [123],
"organizations_bulk_domain": "<string>",
"organization_domains": ["<string>"],
"organization_description": "<string>",
"organization_locations": [123],
"organization_industries": [123],
"organization_industries_exclude": [123],
"organization_keywords": [123],
"organization_web_technologies": [123],
"organization_founded_date_start": "2023-12-25",
"organization_founded_date_end": "2023-12-25",
"organization_employees_start": 123,
"organization_employees_end": 123,
"organization_revenue_start": 123,
"organization_revenue_end": 123,
"organization_domain_rank_start": 123,
"organization_domain_rank_end": 123,
"organization_linkedin_public_identifiers": ["<string>"],
"funding_types": [],
"funding_total_start": 123,
"funding_total_end": 123,
"funding_event_date_featured_start": "2023-12-25",
"funding_event_date_featured_end": "2023-12-25",
"job_post_title": "<string>",
"job_post_description": "<string>",
"job_post_is_remote": True,
"job_post_is_active": True,
"job_post_date_featured_start": "2023-12-25",
"job_post_date_featured_end": "2023-12-25",
"job_post_locations": [123],
"job_post_locations_exclude": [123],
"simple_event_date_featured_start": "2023-12-25",
"simple_event_date_featured_end": "2023-12-25"
}
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({
page: 123,
role_title: '<string>',
role_description: '<string>',
role_is_current: true,
role_position_start_date: '2023-12-25',
role_position_end_date: '2023-12-25',
role_years_on_position_start: 123,
role_years_on_position_end: 123,
person_name: '<string>',
person_headline: '<string>',
person_description: '<string>',
person_skills: [123],
person_locations: [123],
person_industries: [123],
person_industries_exclude: [123],
person_linkedin_public_identifiers: ['<string>'],
organizations: [123],
organizations_bulk_domain: '<string>',
organization_domains: ['<string>'],
organization_description: '<string>',
organization_locations: [123],
organization_industries: [123],
organization_industries_exclude: [123],
organization_keywords: [123],
organization_web_technologies: [123],
organization_founded_date_start: '2023-12-25',
organization_founded_date_end: '2023-12-25',
organization_employees_start: 123,
organization_employees_end: 123,
organization_revenue_start: 123,
organization_revenue_end: 123,
organization_domain_rank_start: 123,
organization_domain_rank_end: 123,
organization_linkedin_public_identifiers: ['<string>'],
funding_types: [],
funding_total_start: 123,
funding_total_end: 123,
funding_event_date_featured_start: '2023-12-25',
funding_event_date_featured_end: '2023-12-25',
job_post_title: '<string>',
job_post_description: '<string>',
job_post_is_remote: true,
job_post_is_active: true,
job_post_date_featured_start: '2023-12-25',
job_post_date_featured_end: '2023-12-25',
job_post_locations: [123],
job_post_locations_exclude: [123],
simple_event_date_featured_start: '2023-12-25',
simple_event_date_featured_end: '2023-12-25'
})
};
fetch('https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
page: 123,
role_title: '<string>',
role_description: '<string>',
role_is_current: true,
role_position_start_date: '2023-12-25',
role_position_end_date: '2023-12-25',
role_years_on_position_start: 123,
role_years_on_position_end: 123,
person_name: '<string>',
person_headline: '<string>',
person_description: '<string>',
person_skills: [123],
person_locations: [123],
person_industries: [123],
person_industries_exclude: [123],
person_linkedin_public_identifiers: ['<string>'],
organizations: [123],
organizations_bulk_domain: '<string>',
organization_domains: ['<string>'],
organization_description: '<string>',
organization_locations: [123],
organization_industries: [123],
organization_industries_exclude: [123],
organization_keywords: [123],
organization_web_technologies: [123],
organization_founded_date_start: '2023-12-25',
organization_founded_date_end: '2023-12-25',
organization_employees_start: 123,
organization_employees_end: 123,
organization_revenue_start: 123,
organization_revenue_end: 123,
organization_domain_rank_start: 123,
organization_domain_rank_end: 123,
organization_linkedin_public_identifiers: ['<string>'],
funding_types: [],
funding_total_start: 123,
funding_total_end: 123,
funding_event_date_featured_start: '2023-12-25',
funding_event_date_featured_end: '2023-12-25',
job_post_title: '<string>',
job_post_description: '<string>',
job_post_is_remote: true,
job_post_is_active: true,
job_post_date_featured_start: '2023-12-25',
job_post_date_featured_end: '2023-12-25',
job_post_locations: [123],
job_post_locations_exclude: [123],
simple_event_date_featured_start: '2023-12-25',
simple_event_date_featured_end: '2023-12-25'
})
};
fetch('https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/"
payload := strings.NewReader("{\n \"page\": 123,\n \"role_title\": \"<string>\",\n \"role_description\": \"<string>\",\n \"role_is_current\": true,\n \"role_position_start_date\": \"2023-12-25\",\n \"role_position_end_date\": \"2023-12-25\",\n \"role_years_on_position_start\": 123,\n \"role_years_on_position_end\": 123,\n \"person_name\": \"<string>\",\n \"person_headline\": \"<string>\",\n \"person_description\": \"<string>\",\n \"person_skills\": [\n 123\n ],\n \"person_locations\": [\n 123\n ],\n \"person_industries\": [\n 123\n ],\n \"person_industries_exclude\": [\n 123\n ],\n \"person_linkedin_public_identifiers\": [\n \"<string>\"\n ],\n \"organizations\": [\n 123\n ],\n \"organizations_bulk_domain\": \"<string>\",\n \"organization_domains\": [\n \"<string>\"\n ],\n \"organization_description\": \"<string>\",\n \"organization_locations\": [\n 123\n ],\n \"organization_industries\": [\n 123\n ],\n \"organization_industries_exclude\": [\n 123\n ],\n \"organization_keywords\": [\n 123\n ],\n \"organization_web_technologies\": [\n 123\n ],\n \"organization_founded_date_start\": \"2023-12-25\",\n \"organization_founded_date_end\": \"2023-12-25\",\n \"organization_employees_start\": 123,\n \"organization_employees_end\": 123,\n \"organization_revenue_start\": 123,\n \"organization_revenue_end\": 123,\n \"organization_domain_rank_start\": 123,\n \"organization_domain_rank_end\": 123,\n \"organization_linkedin_public_identifiers\": [\n \"<string>\"\n ],\n \"funding_types\": [],\n \"funding_total_start\": 123,\n \"funding_total_end\": 123,\n \"funding_event_date_featured_start\": \"2023-12-25\",\n \"funding_event_date_featured_end\": \"2023-12-25\",\n \"job_post_title\": \"<string>\",\n \"job_post_description\": \"<string>\",\n \"job_post_is_remote\": true,\n \"job_post_is_active\": true,\n \"job_post_date_featured_start\": \"2023-12-25\",\n \"job_post_date_featured_end\": \"2023-12-25\",\n \"job_post_locations\": [\n 123\n ],\n \"job_post_locations_exclude\": [\n 123\n ],\n \"simple_event_date_featured_start\": \"2023-12-25\",\n \"simple_event_date_featured_end\": \"2023-12-25\"\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))
}require 'uri'
require 'net/http'
url = URI("https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/")
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 \"page\": 123,\n \"role_title\": \"<string>\",\n \"role_description\": \"<string>\",\n \"role_is_current\": true,\n \"role_position_start_date\": \"2023-12-25\",\n \"role_position_end_date\": \"2023-12-25\",\n \"role_years_on_position_start\": 123,\n \"role_years_on_position_end\": 123,\n \"person_name\": \"<string>\",\n \"person_headline\": \"<string>\",\n \"person_description\": \"<string>\",\n \"person_skills\": [\n 123\n ],\n \"person_locations\": [\n 123\n ],\n \"person_industries\": [\n 123\n ],\n \"person_industries_exclude\": [\n 123\n ],\n \"person_linkedin_public_identifiers\": [\n \"<string>\"\n ],\n \"organizations\": [\n 123\n ],\n \"organizations_bulk_domain\": \"<string>\",\n \"organization_domains\": [\n \"<string>\"\n ],\n \"organization_description\": \"<string>\",\n \"organization_locations\": [\n 123\n ],\n \"organization_industries\": [\n 123\n ],\n \"organization_industries_exclude\": [\n 123\n ],\n \"organization_keywords\": [\n 123\n ],\n \"organization_web_technologies\": [\n 123\n ],\n \"organization_founded_date_start\": \"2023-12-25\",\n \"organization_founded_date_end\": \"2023-12-25\",\n \"organization_employees_start\": 123,\n \"organization_employees_end\": 123,\n \"organization_revenue_start\": 123,\n \"organization_revenue_end\": 123,\n \"organization_domain_rank_start\": 123,\n \"organization_domain_rank_end\": 123,\n \"organization_linkedin_public_identifiers\": [\n \"<string>\"\n ],\n \"funding_types\": [],\n \"funding_total_start\": 123,\n \"funding_total_end\": 123,\n \"funding_event_date_featured_start\": \"2023-12-25\",\n \"funding_event_date_featured_end\": \"2023-12-25\",\n \"job_post_title\": \"<string>\",\n \"job_post_description\": \"<string>\",\n \"job_post_is_remote\": true,\n \"job_post_is_active\": true,\n \"job_post_date_featured_start\": \"2023-12-25\",\n \"job_post_date_featured_end\": \"2023-12-25\",\n \"job_post_locations\": [\n 123\n ],\n \"job_post_locations_exclude\": [\n 123\n ],\n \"simple_event_date_featured_start\": \"2023-12-25\",\n \"simple_event_date_featured_end\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/",
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([
'page' => 123,
'role_title' => '<string>',
'role_description' => '<string>',
'role_is_current' => true,
'role_position_start_date' => '2023-12-25',
'role_position_end_date' => '2023-12-25',
'role_years_on_position_start' => 123,
'role_years_on_position_end' => 123,
'person_name' => '<string>',
'person_headline' => '<string>',
'person_description' => '<string>',
'person_skills' => [
123
],
'person_locations' => [
123
],
'person_industries' => [
123
],
'person_industries_exclude' => [
123
],
'person_linkedin_public_identifiers' => [
'<string>'
],
'organizations' => [
123
],
'organizations_bulk_domain' => '<string>',
'organization_domains' => [
'<string>'
],
'organization_description' => '<string>',
'organization_locations' => [
123
],
'organization_industries' => [
123
],
'organization_industries_exclude' => [
123
],
'organization_keywords' => [
123
],
'organization_web_technologies' => [
123
],
'organization_founded_date_start' => '2023-12-25',
'organization_founded_date_end' => '2023-12-25',
'organization_employees_start' => 123,
'organization_employees_end' => 123,
'organization_revenue_start' => 123,
'organization_revenue_end' => 123,
'organization_domain_rank_start' => 123,
'organization_domain_rank_end' => 123,
'organization_linkedin_public_identifiers' => [
'<string>'
],
'funding_types' => [
],
'funding_total_start' => 123,
'funding_total_end' => 123,
'funding_event_date_featured_start' => '2023-12-25',
'funding_event_date_featured_end' => '2023-12-25',
'job_post_title' => '<string>',
'job_post_description' => '<string>',
'job_post_is_remote' => true,
'job_post_is_active' => true,
'job_post_date_featured_start' => '2023-12-25',
'job_post_date_featured_end' => '2023-12-25',
'job_post_locations' => [
123
],
'job_post_locations_exclude' => [
123
],
'simple_event_date_featured_start' => '2023-12-25',
'simple_event_date_featured_end' => '2023-12-25'
]),
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;
}HttpResponse<String> response = Unirest.post("https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"page\": 123,\n \"role_title\": \"<string>\",\n \"role_description\": \"<string>\",\n \"role_is_current\": true,\n \"role_position_start_date\": \"2023-12-25\",\n \"role_position_end_date\": \"2023-12-25\",\n \"role_years_on_position_start\": 123,\n \"role_years_on_position_end\": 123,\n \"person_name\": \"<string>\",\n \"person_headline\": \"<string>\",\n \"person_description\": \"<string>\",\n \"person_skills\": [\n 123\n ],\n \"person_locations\": [\n 123\n ],\n \"person_industries\": [\n 123\n ],\n \"person_industries_exclude\": [\n 123\n ],\n \"person_linkedin_public_identifiers\": [\n \"<string>\"\n ],\n \"organizations\": [\n 123\n ],\n \"organizations_bulk_domain\": \"<string>\",\n \"organization_domains\": [\n \"<string>\"\n ],\n \"organization_description\": \"<string>\",\n \"organization_locations\": [\n 123\n ],\n \"organization_industries\": [\n 123\n ],\n \"organization_industries_exclude\": [\n 123\n ],\n \"organization_keywords\": [\n 123\n ],\n \"organization_web_technologies\": [\n 123\n ],\n \"organization_founded_date_start\": \"2023-12-25\",\n \"organization_founded_date_end\": \"2023-12-25\",\n \"organization_employees_start\": 123,\n \"organization_employees_end\": 123,\n \"organization_revenue_start\": 123,\n \"organization_revenue_end\": 123,\n \"organization_domain_rank_start\": 123,\n \"organization_domain_rank_end\": 123,\n \"organization_linkedin_public_identifiers\": [\n \"<string>\"\n ],\n \"funding_types\": [],\n \"funding_total_start\": 123,\n \"funding_total_end\": 123,\n \"funding_event_date_featured_start\": \"2023-12-25\",\n \"funding_event_date_featured_end\": \"2023-12-25\",\n \"job_post_title\": \"<string>\",\n \"job_post_description\": \"<string>\",\n \"job_post_is_remote\": true,\n \"job_post_is_active\": true,\n \"job_post_date_featured_start\": \"2023-12-25\",\n \"job_post_date_featured_end\": \"2023-12-25\",\n \"job_post_locations\": [\n 123\n ],\n \"job_post_locations_exclude\": [\n 123\n ],\n \"simple_event_date_featured_start\": \"2023-12-25\",\n \"simple_event_date_featured_end\": \"2023-12-25\"\n}")
.asString();{
"total_search_results": 1,
"total_persons": 1,
"total_organizations": 1
}{
"detail": "Authentication credentials were not provided."
}When to use this endpoint
You want to know how many people, and how many companies, a people search would return before paying for pages of results. Thetotals endpoint takes the same body as the search and returns only the count, so count first and page only through the matches you need.
Example request
cURL
curl -X POST "https://api-v2.forager.ai/api/$FORAGER_ACCOUNT_ID/datastorage/person_role_search/totals/" \
-H "X-API-KEY: $FORAGER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"role_title": "Head of Data",
"role_is_current": true,
"organization_domains": [
"acme.com"
]
}'
FORAGER_API_KEY and FORAGER_ACCOUNT_ID as in the quickstart.
Example response
200 (illustrative values)
{
"total_search_results": 1,
"total_persons": 1,
"total_organizations": 1
}
Credits
Each request costs 1 credit. See API credits and pricing for how credits are charged and how to check what you spent.Authorizations
Path Parameters
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
OrganizationPersonRole search request serializer.
This field supports a boolean text search query.
This field supports a boolean text search query.
This field supports a boolean text search query.
This field supports a boolean text search query.
This field supports a boolean text search query.
To get a list of IDs use Person skills lookup endpoint.
To get a list of IDs use Locations lookup endpoint.
To get a list of IDs use Industries lookup endpoint.
To get a list of IDs use Industries lookup endpoint.
LinkedIn person "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/".
To get a list of IDs use Organizations lookup endpoint.
This field supports a boolean text search query.
This field supports a boolean text search query.
To get a list of IDs use Locations lookup endpoint.
To get a list of IDs use Industries lookup endpoint.
To get a list of IDs use Industries lookup endpoint.
To get a list of IDs use Organization keywords lookup endpoint.
To get a list of IDs use Web technologies lookup endpoint.
LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/company/!slug!/".
angel- Angelconvertible_note- Convertible Notecorporate_round- Corporate Rounddebt_financing- Debt Financingequity_crowdfunding- Equity Crowdfundinggrant- Grantinitial_coin_offering- Initial coin offering (ICO)non_equity_assistance- Non-Equity Assistancepost_ipo_debt- Post-IPO Debtpost_ipo_equity- Post-IPO Equitypost_ipo_secondary- Post-IPO Secondarypre_seed- Pre-Seedprivate_equity- Private Equityproduct_crowdfunding- Product Crowdfundingsecondary_market- Secondary Marketseed- Seedseries_a- Series Aseries_b- Series Bseries_c- Series Cseries_d- Series Dseries_e- Series Eseries_f- Series Fseries_g- Series Gseries_h- Series Hseries_i- Series Iseries_j- Series Jseries_unknown- Venture - Series Unknownundisclosed- Undisclosed
Available options:
angel, convertible_note, corporate_round, debt_financing, equity_crowdfunding, grant, initial_coin_offering, non_equity_assistance, post_ipo_debt, post_ipo_equity, post_ipo_secondary, pre_seed, private_equity, product_crowdfunding, secondary_market, seed, series_a, series_b, series_c, series_d, series_e, series_f, series_g, series_h, series_i, series_j, series_unknown, undisclosed This field supports a boolean text search query.
This field supports a boolean text search query.
To get a list of IDs use Locations lookup endpoint.
To get a list of IDs use Locations lookup endpoint.
product_hunt- Product Huntform_c_sec_gov- Form C sec.govform_d_sec_gov- Form D sec.gov
Available options:
product_hunt, form_c_sec_gov, form_d_sec_gov report_released- Report releasedpromoted_on_site- Promoted on site
Available options:
report_released, promoted_on_site Last modified on November 1, 2026