Skip to content
/
Phone numbers lookup

Forager public API (1.0.0)

Forager public API endpoints documentation

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://api-v2.forager.ai/

Job Posts

Operations

Organizations

Operations

People

Operations

Personal emails lookup

Request

The Person Personal Emails Lookup endpoint retrieves personal email addresses associated with an individual in the Forager dataset. It allows you to input identifying information (such as Linkedin handle or Forager ID) and returns available personal contact emails. Personal emails may include both free webmail addresses (e.g., Gmail, Yahoo) and custom domains that look like company domains but are used for personal purposes. For example, if a user registers for services like LinkedIn with a custom domain for personal use, that email will appear in personal searches.

Security
Api-Key
Path
account_idintegerrequired
Body
person_idinteger
linkedin_public_identifierstring

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/".

curl -i -X POST \
  'https://api-v2.forager.ai/api/{account_id}/datastorage/person_contacts_lookup/personal_emails/' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "person_id": 0,
    "linkedin_public_identifier": "string"
  }'

Responses

Bodyapplication/jsonArray [
emailstring(email)read-onlyrequired
email_typestringread-onlyrequired
validation_statusstringread-onlyrequired
  • valid - Valid
  • risky - Risky
  • invalid - Invalid
  • unknown - Unknown
Enum"valid""risky""invalid""unknown"
]
Response
application/json
[
  {
    "email": "user@example.com",
    "email_type": "string",
    "validation_status": "valid"
  }
]

Phone numbers lookup

Request

The Person Phone Numbers Lookup endpoint retrieves phone numbers associated with an individual in the Forager dataset. It allows you to input identifying information (such as Linkedin handle or Forager ID) and returns available phone numbers. This API is useful for enriching person records, supporting lead generation, and verifying phone contact details within your applications.

Security
Api-Key
Path
account_idintegerrequired
Body
person_idinteger
linkedin_public_identifierstring

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/".

curl -i -X POST \
  'https://api-v2.forager.ai/api/{account_id}/datastorage/person_contacts_lookup/phone_numbers/' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "person_id": 0,
    "linkedin_public_identifier": "string"
  }'

Responses

Bodyapplication/jsonArray [
phone_numberstringread-onlyrequired
]
Response
application/json
[
  {
    "phone_number": "string"
  }
]

Work emails lookup

Request

The Person Work Emails Lookup endpoint retrieves work email addresses associated with an individual in the Forager dataset. It allows you to input identifying information (such as Linkedin handle or Forager ID) and returns available work email addresses. This API is useful for enriching person records, supporting lead generation, and verifying work contact details within your applications.

Security
Api-Key
Path
account_idintegerrequired
Body
person_idinteger
linkedin_public_identifierstring

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/".

do_contacts_enrichmentboolean
Default false
curl -i -X POST \
  'https://api-v2.forager.ai/api/{account_id}/datastorage/person_contacts_lookup/work_emails/' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "person_id": 0,
    "linkedin_public_identifier": "string",
    "do_contacts_enrichment": false
  }'

Responses

Bodyapplication/jsonArray [
emailstring(email)read-onlyrequired
email_typestringread-onlyrequired
validation_statusstringread-onlyrequired
  • valid - Valid
  • risky - Risky
  • invalid - Invalid
  • unknown - Unknown
Enum"valid""risky""invalid""unknown"
]
Response
application/json
[
  {
    "email": "user@example.com",
    "email_type": "string",
    "validation_status": "valid"
  }
]

Person detail lookup

Request

Do Person details lookup.

Security
Api-Key
Path
account_idintegerrequired
Body
person_idinteger
linkedin_public_identifierstring

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/".

curl -i -X POST \
  'https://api-v2.forager.ai/api/{account_id}/datastorage/person_detail_lookup/' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "person_id": 0,
    "linkedin_public_identifier": "string"
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
full_namestring<= 255 charactersrequired
first_namestring<= 255 charactersrequired
last_namestring or null<= 255 characters
photostring or null(uri)<= 255 characters
genderstring or null<= 255 characters
headlinestring or null<= 255 characters
descriptionstring or null
skillsArray of objects(PersonSkill)read-onlyrequired
skills[].​namestring<= 255 charactersrequired
locationobjectread-onlyrequired

Serializer for the InnerLocation model.

location.​idintegerread-onlyrequired
location.​namestring<= 255 charactersrequired
location.​osm_locationsArray of objects(OSMLocation)read-onlyrequired
location.​osm_locations[].​idintegerread-onlyrequired
location.​osm_locations[].​namestring<= 255 charactersrequired
location.​osm_locations[].​place_typestring(Type)<= 255 charactersrequired
linkedin_infoobjectread-onlyrequired

Serializer for the PersonLinkedinInfo model.

linkedin_info.​public_identifierstring or null<= 255 characters
linkedin_info.​industryobjectread-onlyrequired

Serializer for the LinkedinIndustry document.

linkedin_info.​industry.​idintegerread-onlyrequired
linkedin_info.​industry.​namestring<= 255 charactersrequired
linkedin_info.​public_profile_urlstringread-onlyrequired

Get LinkedIn public profile URL.

rolesArray of objects(PersonRoleChild)required
roles[].​idintegerread-onlyrequired
roles[].​role_titlestring or null<= 255 characters
roles[].​start_datestring or null(date)
roles[].​end_datestring or null(date)
roles[].​durationstring or null(Role duration)<= 255 characters
roles[].​descriptionstring or null
roles[].​is_currentboolean(Is current?)required
roles[].​organizationobjectread-onlyrequired

Short serializer for the Organization model.

roles[].​organization.​idintegerread-onlyrequired
roles[].​organization.​namestring<= 255 charactersrequired
roles[].​organization.​domainstring or null(uri)<= 200 characters
roles[].​organization.​linkedin_infoobjectread-onlyrequired

Serializer for the OrganizationLinkedinInfo model.

roles[].​organization.​linkedin_info.​public_identifierstring or null<= 255 characters
roles[].​organization.​linkedin_info.​industryobjectread-onlyrequired

Serializer for the LinkedinIndustry document.

roles[].​organization.​linkedin_info.​industry.​idintegerread-onlyrequired
roles[].​organization.​linkedin_info.​industry.​namestring<= 255 charactersrequired
roles[].​organization.​linkedin_info.​public_profile_urlstring or nullread-onlyrequired

Get LinkedIn public profile URL.

roles[].​organization_namestring or null<= 255 characters
educationsArray of objects(PersonEducation)required
educations[].​idintegerread-onlyrequired
educations[].​school_namestring<= 255 charactersrequired
educations[].​organizationobjectread-onlyrequired

Short serializer for the Organization model.

educations[].​organization.​idintegerread-onlyrequired
educations[].​organization.​namestring<= 255 charactersrequired
educations[].​organization.​domainstring or null(uri)<= 200 characters
educations[].​organization.​linkedin_infoobjectread-onlyrequired

Serializer for the OrganizationLinkedinInfo model.

educations[].​organization.​linkedin_info.​public_identifierstring or null<= 255 characters
educations[].​organization.​linkedin_info.​industryobjectread-onlyrequired

Serializer for the LinkedinIndustry document.

educations[].​organization.​linkedin_info.​industry.​idintegerread-onlyrequired
educations[].​organization.​linkedin_info.​industry.​namestring<= 255 charactersrequired
educations[].​organization.​linkedin_info.​public_profile_urlstring or nullread-onlyrequired

Get LinkedIn public profile URL.

educations[].​descriptionstring or null
educations[].​gradestring or null<= 255 characters
educations[].​degreestring or null<= 255 characters
educations[].​activitiesstring or null<= 255 characters
educations[].​field_of_studystring or null<= 255 characters
educations[].​start_datestring or null(date)
educations[].​end_datestring or null(date)
certificationsArray of objects(PersonCertification)read-onlyrequired
certifications[].​idintegerread-onlyrequired
certifications[].​organization_idinteger or nullread-onlyrequired
certifications[].​namestring<= 510 charactersrequired
certifications[].​certificate_idstring or null<= 255 characters
certifications[].​urlstring or null(uri)<= 16384 characters
certifications[].​authoritystring or null<= 255 characters
coursesArray of objects(PersonCourse)read-onlyrequired
courses[].​idintegerread-onlyrequired
courses[].​namestring<= 1515 charactersrequired
courses[].​numberstring or null<= 255 characters
courses[].​associated_role_idinteger or nullread-onlyrequired
courses[].​associated_education_idinteger or nullread-onlyrequired
honorsArray of objects(PersonHonor)read-onlyrequired
honors[].​idintegerread-onlyrequired
honors[].​titlestring<= 510 charactersrequired
honors[].​descriptionstring or null
honors[].​issuerstring or null
honors[].​issued_onstring or null(date)
honors[].​associated_role_idinteger or nullread-onlyrequired
honors[].​associated_education_idinteger or nullread-onlyrequired
languagesArray of objects(PersonLanguage)read-onlyrequired
languages[].​idintegerread-onlyrequired
languages[].​namestring<= 255 charactersrequired
languages[].​proficiencystring or null<= 255 characters
organizationsArray of objects(PersonOrganization)read-onlyrequired
organizations[].​idintegerread-onlyrequired
organizations[].​namestring(Title)<= 510 charactersrequired
organizations[].​descriptionstring or null
organizations[].​role_titlestring or null<= 1515 characters
organizations[].​associated_role_idinteger or nullread-onlyrequired
organizations[].​associated_education_idinteger or nullread-onlyrequired
patentsArray of objects(PersonPatent)read-onlyrequired
patents[].​idintegerread-onlyrequired
patents[].​titlestring<= 510 charactersrequired
patents[].​descriptionstring or null
patents[].​patent_numberstring or null<= 125 characters
patents[].​application_numberstring or null<= 255 characters
patents[].​is_pendingbooleanrequired
patents[].​urlstring or null(uri)<= 16384 characters
patents[].​issued_onstring or null(date)
patents[].​filled_onstring or null(date)
patents[].​linkedin_inventors_idsArray of integersread-onlyrequired

Get list of ids of persons who authored this patent.

patents[].​non_linkedin_inventorsArray of strings
publicationsArray of objects(PersonPublication)read-onlyrequired
publications[].​idintegerread-onlyrequired
publications[].​namestring<= 510 charactersrequired
publications[].​descriptionstring or null
publications[].​urlstring or null(uri)<= 16384 characters
publications[].​publisherstring or null<= 510 characters
publications[].​published_instring or null(date)
publications[].​linkedin_authors_idsArray of integersread-onlyrequired

Get list of ids of persons who authored this publication.

publications[].​non_linkedin_authorsArray of strings
test_scoresArray of objects(PersonTestScore)read-onlyrequired
test_scores[].​idintegerread-onlyrequired
test_scores[].​namestring<= 510 charactersrequired
test_scores[].​descriptionstring or null
test_scores[].​scorestring or null<= 65 characters
test_scores[].​date_onstring or null(date)
test_scores[].​associated_role_idinteger or nullread-onlyrequired
test_scores[].​associated_education_idinteger or nullread-onlyrequired
projectsArray of objects(PersonProject)read-onlyrequired
projects[].​idintegerread-onlyrequired
projects[].​titlestring<= 510 charactersrequired
projects[].​urlstring or null(uri)<= 16384 characters
projects[].​descriptionstring or null
projects[].​start_datestring or null(date)
projects[].​end_datestring or null(date)
projects[].​associated_role_idinteger or nullread-onlyrequired
projects[].​associated_education_idinteger or nullread-onlyrequired
projects[].​linkedin_contributors_idsArray of integersread-onlyrequired

Get list of ids of persons who contributed to this project.

projects[].​non_linkedin_contributorsArray of strings
volunteeringArray of objects(PersonVolunteering)read-onlyrequired
volunteering[].​idintegerread-onlyrequired
volunteering[].​titlestring(Name)<= 255 charactersrequired
volunteering[].​descriptionstring or null
volunteering[].​causestring or null<= 255 characters
volunteering[].​organization_namestring<= 255 charactersrequired
volunteering[].​organization_idinteger or nullread-onlyrequired
volunteering[].​start_datestring or null(date)
volunteering[].​end_datestring or null(date)
Response
application/json
{
  "id": 0,
  "full_name": "string",
  "first_name": "string",
  "last_name": "string",
  "photo": "http://example.com",
  "gender": "string",
  "headline": "string",
  "description": "string",
  "skills": [
    { … }
  ],
  "location": {
    "id": 0,
    "name": "string",
    "osm_locations": [ … ]
  },
  "linkedin_info": {
    "public_identifier": "string",
    "industry": { … },
    "public_profile_url": "string"
  },
  "roles": [
    { … }
  ],
  "educations": [
    { … }
  ],
  "certifications": [
    { … }
  ],
  "courses": [
    { … }
  ],
  "honors": [
    { … }
  ],
  "languages": [
    { … }
  ],
  "organizations": [
    { … }
  ],
  "patents": [
    { … }
  ],
  "publications": [
    { … }
  ],
  "test_scores": [
    { … }
  ],
  "projects": [
    { … }
  ],
  "volunteering": [
    { … }
  ]
}

Person detail lookup by email

Request

Do reverse lookup of person details by email.

Security
Api-Key
Path
account_idintegerrequired
Body
required
emailstring(email)required

The personal email address of the person being searched.

curl -i -X POST \
  'https://api-v2.forager.ai/api/{account_id}/datastorage/person_detail_reverse_lookup/by_email/' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "email": "user@example.com"
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
full_namestring<= 255 charactersrequired
first_namestring<= 255 charactersrequired
last_namestring or null<= 255 characters
photostring or null(uri)<= 255 characters
genderstring or null<= 255 characters
headlinestring or null<= 255 characters
descriptionstring or null
skillsArray of objects(PersonSkill)read-onlyrequired
skills[].​namestring<= 255 charactersrequired
locationobjectread-onlyrequired

Serializer for the InnerLocation model.

location.​idintegerread-onlyrequired
location.​namestring<= 255 charactersrequired
location.​osm_locationsArray of objects(OSMLocation)read-onlyrequired
location.​osm_locations[].​idintegerread-onlyrequired
location.​osm_locations[].​namestring<= 255 charactersrequired
location.​osm_locations[].​place_typestring(Type)<= 255 charactersrequired
linkedin_infoobjectread-onlyrequired

Serializer for the PersonLinkedinInfo model.

linkedin_info.​public_identifierstring or null<= 255 characters
linkedin_info.​industryobjectread-onlyrequired

Serializer for the LinkedinIndustry document.

linkedin_info.​industry.​idintegerread-onlyrequired
linkedin_info.​industry.​namestring<= 255 charactersrequired
linkedin_info.​public_profile_urlstringread-onlyrequired

Get LinkedIn public profile URL.

rolesArray of objects(PersonRoleChild)required
roles[].​idintegerread-onlyrequired
roles[].​role_titlestring or null<= 255 characters
roles[].​start_datestring or null(date)
roles[].​end_datestring or null(date)
roles[].​durationstring or null(Role duration)<= 255 characters
roles[].​descriptionstring or null
roles[].​is_currentboolean(Is current?)required
roles[].​organizationobjectread-onlyrequired

Short serializer for the Organization model.

roles[].​organization.​idintegerread-onlyrequired
roles[].​organization.​namestring<= 255 charactersrequired
roles[].​organization.​domainstring or null(uri)<= 200 characters
roles[].​organization.​linkedin_infoobjectread-onlyrequired

Serializer for the OrganizationLinkedinInfo model.

roles[].​organization.​linkedin_info.​public_identifierstring or null<= 255 characters
roles[].​organization.​linkedin_info.​industryobjectread-onlyrequired

Serializer for the LinkedinIndustry document.

roles[].​organization.​linkedin_info.​industry.​idintegerread-onlyrequired
roles[].​organization.​linkedin_info.​industry.​namestring<= 255 charactersrequired
roles[].​organization.​linkedin_info.​public_profile_urlstring or nullread-onlyrequired

Get LinkedIn public profile URL.

roles[].​organization_namestring or null<= 255 characters
educationsArray of objects(PersonEducation)required
educations[].​idintegerread-onlyrequired
educations[].​school_namestring<= 255 charactersrequired
educations[].​organizationobjectread-onlyrequired

Short serializer for the Organization model.

educations[].​organization.​idintegerread-onlyrequired
educations[].​organization.​namestring<= 255 charactersrequired
educations[].​organization.​domainstring or null(uri)<= 200 characters
educations[].​organization.​linkedin_infoobjectread-onlyrequired

Serializer for the OrganizationLinkedinInfo model.

educations[].​organization.​linkedin_info.​public_identifierstring or null<= 255 characters
educations[].​organization.​linkedin_info.​industryobjectread-onlyrequired

Serializer for the LinkedinIndustry document.

educations[].​organization.​linkedin_info.​industry.​idintegerread-onlyrequired
educations[].​organization.​linkedin_info.​industry.​namestring<= 255 charactersrequired
educations[].​organization.​linkedin_info.​public_profile_urlstring or nullread-onlyrequired

Get LinkedIn public profile URL.

educations[].​descriptionstring or null
educations[].​gradestring or null<= 255 characters
educations[].​degreestring or null<= 255 characters
educations[].​activitiesstring or null<= 255 characters
educations[].​field_of_studystring or null<= 255 characters
educations[].​start_datestring or null(date)
educations[].​end_datestring or null(date)
certificationsArray of objects(PersonCertification)read-onlyrequired
certifications[].​idintegerread-onlyrequired
certifications[].​organization_idinteger or nullread-onlyrequired
certifications[].​namestring<= 510 charactersrequired
certifications[].​certificate_idstring or null<= 255 characters
certifications[].​urlstring or null(uri)<= 16384 characters
certifications[].​authoritystring or null<= 255 characters
coursesArray of objects(PersonCourse)read-onlyrequired
courses[].​idintegerread-onlyrequired
courses[].​namestring<= 1515 charactersrequired
courses[].​numberstring or null<= 255 characters
courses[].​associated_role_idinteger or nullread-onlyrequired
courses[].​associated_education_idinteger or nullread-onlyrequired
honorsArray of objects(PersonHonor)read-onlyrequired
honors[].​idintegerread-onlyrequired
honors[].​titlestring<= 510 charactersrequired
honors[].​descriptionstring or null
honors[].​issuerstring or null
honors[].​issued_onstring or null(date)
honors[].​associated_role_idinteger or nullread-onlyrequired
honors[].​associated_education_idinteger or nullread-onlyrequired
languagesArray of objects(PersonLanguage)read-onlyrequired
languages[].​idintegerread-onlyrequired
languages[].​namestring<= 255 charactersrequired
languages[].​proficiencystring or null<= 255 characters
organizationsArray of objects(PersonOrganization)read-onlyrequired
organizations[].​idintegerread-onlyrequired
organizations[].​namestring(Title)<= 510 charactersrequired
organizations[].​descriptionstring or null
organizations[].​role_titlestring or null<= 1515 characters
organizations[].​associated_role_idinteger or nullread-onlyrequired
organizations[].​associated_education_idinteger or nullread-onlyrequired
patentsArray of objects(PersonPatent)read-onlyrequired
patents[].​idintegerread-onlyrequired
patents[].​titlestring<= 510 charactersrequired
patents[].​descriptionstring or null
patents[].​patent_numberstring or null<= 125 characters
patents[].​application_numberstring or null<= 255 characters
patents[].​is_pendingbooleanrequired
patents[].​urlstring or null(uri)<= 16384 characters
patents[].​issued_onstring or null(date)
patents[].​filled_onstring or null(date)
patents[].​linkedin_inventors_idsArray of integersread-onlyrequired

Get list of ids of persons who authored this patent.

patents[].​non_linkedin_inventorsArray of strings
publicationsArray of objects(PersonPublication)read-onlyrequired
publications[].​idintegerread-onlyrequired
publications[].​namestring<= 510 charactersrequired
publications[].​descriptionstring or null
publications[].​urlstring or null(uri)<= 16384 characters
publications[].​publisherstring or null<= 510 characters
publications[].​published_instring or null(date)
publications[].​linkedin_authors_idsArray of integersread-onlyrequired

Get list of ids of persons who authored this publication.

publications[].​non_linkedin_authorsArray of strings
test_scoresArray of objects(PersonTestScore)read-onlyrequired
test_scores[].​idintegerread-onlyrequired
test_scores[].​namestring<= 510 charactersrequired
test_scores[].​descriptionstring or null
test_scores[].​scorestring or null<= 65 characters
test_scores[].​date_onstring or null(date)
test_scores[].​associated_role_idinteger or nullread-onlyrequired
test_scores[].​associated_education_idinteger or nullread-onlyrequired
projectsArray of objects(PersonProject)read-onlyrequired
projects[].​idintegerread-onlyrequired
projects[].​titlestring<= 510 charactersrequired
projects[].​urlstring or null(uri)<= 16384 characters
projects[].​descriptionstring or null
projects[].​start_datestring or null(date)
projects[].​end_datestring or null(date)
projects[].​associated_role_idinteger or nullread-onlyrequired
projects[].​associated_education_idinteger or nullread-onlyrequired
projects[].​linkedin_contributors_idsArray of integersread-onlyrequired

Get list of ids of persons who contributed to this project.

projects[].​non_linkedin_contributorsArray of strings
volunteeringArray of objects(PersonVolunteering)read-onlyrequired
volunteering[].​idintegerread-onlyrequired
volunteering[].​titlestring(Name)<= 255 charactersrequired
volunteering[].​descriptionstring or null
volunteering[].​causestring or null<= 255 characters
volunteering[].​organization_namestring<= 255 charactersrequired
volunteering[].​organization_idinteger or nullread-onlyrequired
volunteering[].​start_datestring or null(date)
volunteering[].​end_datestring or null(date)
Response
application/json
{
  "id": 0,
  "full_name": "string",
  "first_name": "string",
  "last_name": "string",
  "photo": "http://example.com",
  "gender": "string",
  "headline": "string",
  "description": "string",
  "skills": [
    { … }
  ],
  "location": {
    "id": 0,
    "name": "string",
    "osm_locations": [ … ]
  },
  "linkedin_info": {
    "public_identifier": "string",
    "industry": { … },
    "public_profile_url": "string"
  },
  "roles": [
    { … }
  ],
  "educations": [
    { … }
  ],
  "certifications": [
    { … }
  ],
  "courses": [
    { … }
  ],
  "honors": [
    { … }
  ],
  "languages": [
    { … }
  ],
  "organizations": [
    { … }
  ],
  "patents": [
    { … }
  ],
  "publications": [
    { … }
  ],
  "test_scores": [
    { … }
  ],
  "projects": [
    { … }
  ],
  "volunteering": [
    { … }
  ]
}

Person detail lookup by phone

Request

Do reverse lookup of person details by phone number.

Security
Api-Key
Path
account_idintegerrequired
Body
required
phone_numberstringrequired
curl -i -X POST \
  'https://api-v2.forager.ai/api/{account_id}/datastorage/person_detail_reverse_lookup/by_phone_number/' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "phone_number": "string"
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
full_namestring<= 255 charactersrequired
first_namestring<= 255 charactersrequired
last_namestring or null<= 255 characters
photostring or null(uri)<= 255 characters
genderstring or null<= 255 characters
headlinestring or null<= 255 characters
descriptionstring or null
skillsArray of objects(PersonSkill)read-onlyrequired
skills[].​namestring<= 255 charactersrequired
locationobjectread-onlyrequired

Serializer for the InnerLocation model.

location.​idintegerread-onlyrequired
location.​namestring<= 255 charactersrequired
location.​osm_locationsArray of objects(OSMLocation)read-onlyrequired
location.​osm_locations[].​idintegerread-onlyrequired
location.​osm_locations[].​namestring<= 255 charactersrequired
location.​osm_locations[].​place_typestring(Type)<= 255 charactersrequired
linkedin_infoobjectread-onlyrequired

Serializer for the PersonLinkedinInfo model.

linkedin_info.​public_identifierstring or null<= 255 characters
linkedin_info.​industryobjectread-onlyrequired

Serializer for the LinkedinIndustry document.

linkedin_info.​industry.​idintegerread-onlyrequired
linkedin_info.​industry.​namestring<= 255 charactersrequired
linkedin_info.​public_profile_urlstringread-onlyrequired

Get LinkedIn public profile URL.

rolesArray of objects(PersonRoleChild)required
roles[].​idintegerread-onlyrequired
roles[].​role_titlestring or null<= 255 characters
roles[].​start_datestring or null(date)
roles[].​end_datestring or null(date)
roles[].​durationstring or null(Role duration)<= 255 characters
roles[].​descriptionstring or null
roles[].​is_currentboolean(Is current?)required
roles[].​organizationobjectread-onlyrequired

Short serializer for the Organization model.

roles[].​organization.​idintegerread-onlyrequired
roles[].​organization.​namestring<= 255 charactersrequired
roles[].​organization.​domainstring or null(uri)<= 200 characters
roles[].​organization.​linkedin_infoobjectread-onlyrequired

Serializer for the OrganizationLinkedinInfo model.

roles[].​organization.​linkedin_info.​public_identifierstring or null<= 255 characters
roles[].​organization.​linkedin_info.​industryobjectread-onlyrequired

Serializer for the LinkedinIndustry document.

roles[].​organization.​linkedin_info.​industry.​idintegerread-onlyrequired
roles[].​organization.​linkedin_info.​industry.​namestring<= 255 charactersrequired
roles[].​organization.​linkedin_info.​public_profile_urlstring or nullread-onlyrequired

Get LinkedIn public profile URL.

roles[].​organization_namestring or null<= 255 characters
educationsArray of objects(PersonEducation)required
educations[].​idintegerread-onlyrequired
educations[].​school_namestring<= 255 charactersrequired
educations[].​organizationobjectread-onlyrequired

Short serializer for the Organization model.

educations[].​organization.​idintegerread-onlyrequired
educations[].​organization.​namestring<= 255 charactersrequired
educations[].​organization.​domainstring or null(uri)<= 200 characters
educations[].​organization.​linkedin_infoobjectread-onlyrequired

Serializer for the OrganizationLinkedinInfo model.

educations[].​organization.​linkedin_info.​public_identifierstring or null<= 255 characters
educations[].​organization.​linkedin_info.​industryobjectread-onlyrequired

Serializer for the LinkedinIndustry document.

educations[].​organization.​linkedin_info.​industry.​idintegerread-onlyrequired
educations[].​organization.​linkedin_info.​industry.​namestring<= 255 charactersrequired
educations[].​organization.​linkedin_info.​public_profile_urlstring or nullread-onlyrequired

Get LinkedIn public profile URL.

educations[].​descriptionstring or null
educations[].​gradestring or null<= 255 characters
educations[].​degreestring or null<= 255 characters
educations[].​activitiesstring or null<= 255 characters
educations[].​field_of_studystring or null<= 255 characters
educations[].​start_datestring or null(date)
educations[].​end_datestring or null(date)
certificationsArray of objects(PersonCertification)read-onlyrequired
certifications[].​idintegerread-onlyrequired
certifications[].​organization_idinteger or nullread-onlyrequired
certifications[].​namestring<= 510 charactersrequired
certifications[].​certificate_idstring or null<= 255 characters
certifications[].​urlstring or null(uri)<= 16384 characters
certifications[].​authoritystring or null<= 255 characters
coursesArray of objects(PersonCourse)read-onlyrequired
courses[].​idintegerread-onlyrequired
courses[].​namestring<= 1515 charactersrequired
courses[].​numberstring or null<= 255 characters
courses[].​associated_role_idinteger or nullread-onlyrequired
courses[].​associated_education_idinteger or nullread-onlyrequired
honorsArray of objects(PersonHonor)read-onlyrequired
honors[].​idintegerread-onlyrequired
honors[].​titlestring<= 510 charactersrequired
honors[].​descriptionstring or null
honors[].​issuerstring or null
honors[].​issued_onstring or null(date)
honors[].​associated_role_idinteger or nullread-onlyrequired
honors[].​associated_education_idinteger or nullread-onlyrequired
languagesArray of objects(PersonLanguage)read-onlyrequired
languages[].​idintegerread-onlyrequired
languages[].​namestring<= 255 charactersrequired
languages[].​proficiencystring or null<= 255 characters
organizationsArray of objects(PersonOrganization)read-onlyrequired
organizations[].​idintegerread-onlyrequired
organizations[].​namestring(Title)<= 510 charactersrequired
organizations[].​descriptionstring or null
organizations[].​role_titlestring or null<= 1515 characters
organizations[].​associated_role_idinteger or nullread-onlyrequired
organizations[].​associated_education_idinteger or nullread-onlyrequired
patentsArray of objects(PersonPatent)read-onlyrequired
patents[].​idintegerread-onlyrequired
patents[].​titlestring<= 510 charactersrequired
patents[].​descriptionstring or null
patents[].​patent_numberstring or null<= 125 characters
patents[].​application_numberstring or null<= 255 characters
patents[].​is_pendingbooleanrequired
patents[].​urlstring or null(uri)<= 16384 characters
patents[].​issued_onstring or null(date)
patents[].​filled_onstring or null(date)
patents[].​linkedin_inventors_idsArray of integersread-onlyrequired

Get list of ids of persons who authored this patent.

patents[].​non_linkedin_inventorsArray of strings
publicationsArray of objects(PersonPublication)read-onlyrequired
publications[].​idintegerread-onlyrequired
publications[].​namestring<= 510 charactersrequired
publications[].​descriptionstring or null
publications[].​urlstring or null(uri)<= 16384 characters
publications[].​publisherstring or null<= 510 characters
publications[].​published_instring or null(date)
publications[].​linkedin_authors_idsArray of integersread-onlyrequired

Get list of ids of persons who authored this publication.

publications[].​non_linkedin_authorsArray of strings
test_scoresArray of objects(PersonTestScore)read-onlyrequired
test_scores[].​idintegerread-onlyrequired
test_scores[].​namestring<= 510 charactersrequired
test_scores[].​descriptionstring or null
test_scores[].​scorestring or null<= 65 characters
test_scores[].​date_onstring or null(date)
test_scores[].​associated_role_idinteger or nullread-onlyrequired
test_scores[].​associated_education_idinteger or nullread-onlyrequired
projectsArray of objects(PersonProject)read-onlyrequired
projects[].​idintegerread-onlyrequired
projects[].​titlestring<= 510 charactersrequired
projects[].​urlstring or null(uri)<= 16384 characters
projects[].​descriptionstring or null
projects[].​start_datestring or null(date)
projects[].​end_datestring or null(date)
projects[].​associated_role_idinteger or nullread-onlyrequired
projects[].​associated_education_idinteger or nullread-onlyrequired
projects[].​linkedin_contributors_idsArray of integersread-onlyrequired

Get list of ids of persons who contributed to this project.

projects[].​non_linkedin_contributorsArray of strings
volunteeringArray of objects(PersonVolunteering)read-onlyrequired
volunteering[].​idintegerread-onlyrequired
volunteering[].​titlestring(Name)<= 255 charactersrequired
volunteering[].​descriptionstring or null
volunteering[].​causestring or null<= 255 characters
volunteering[].​organization_namestring<= 255 charactersrequired
volunteering[].​organization_idinteger or nullread-onlyrequired
volunteering[].​start_datestring or null(date)
volunteering[].​end_datestring or null(date)
Response
application/json
{
  "id": 0,
  "full_name": "string",
  "first_name": "string",
  "last_name": "string",
  "photo": "http://example.com",
  "gender": "string",
  "headline": "string",
  "description": "string",
  "skills": [
    { … }
  ],
  "location": {
    "id": 0,
    "name": "string",
    "osm_locations": [ … ]
  },
  "linkedin_info": {
    "public_identifier": "string",
    "industry": { … },
    "public_profile_url": "string"
  },
  "roles": [
    { … }
  ],
  "educations": [
    { … }
  ],
  "certifications": [
    { … }
  ],
  "courses": [
    { … }
  ],
  "honors": [
    { … }
  ],
  "languages": [
    { … }
  ],
  "organizations": [
    { … }
  ],
  "patents": [
    { … }
  ],
  "publications": [
    { … }
  ],
  "test_scores": [
    { … }
  ],
  "projects": [
    { … }
  ],
  "volunteering": [
    { … }
  ]
}

Person role search

Request

The Person Role Search endpoint lets you search for individuals based on their roles, titles, time periods, and associated organizations. You can filter by attributes like role title or description, current status, start/end dates, person name, skills, industry, and location. The response returns matching person records along with their role history and linked organization details (e.g. name, domain, founding date).

Security
Api-Key
Path
account_idintegerrequired
Body
pageinteger
role_titlestring

This field supports a boolean text search query.

role_descriptionstring

This field supports a boolean text search query.

role_is_currentboolean
Default true
role_position_start_datestring(date)
role_position_end_datestring(date)
role_years_on_position_startinteger
role_years_on_position_endinteger
person_namestring

This field supports a boolean text search query.

person_headlinestring

This field supports a boolean text search query.

person_descriptionstring

This field supports a boolean text search query.

person_skillsArray of integers

To get a list of IDs use Person skills lookup endpoint.

person_locationsArray of integers

To get a list of IDs use Locations lookup endpoint.

person_industriesArray of integers

To get a list of IDs use Industries lookup endpoint.

person_industries_excludeArray of integers

To get a list of IDs use Industries lookup endpoint.

person_linkedin_public_identifiersArray of strings

LinkedIn person "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/".

organizationsArray of integers

To get a list of IDs use Organizations lookup endpoint.

organizations_bulk_domainstring
organization_domainsArray of strings
organization_descriptionstring

This field supports a boolean text search query.

organization_locationsArray of integers

To get a list of IDs use Locations lookup endpoint.

organization_industriesArray of integers

To get a list of IDs use Industries lookup endpoint.

organization_industries_excludeArray of integers

To get a list of IDs use Industries lookup endpoint.

organization_keywordsArray of integers

To get a list of IDs use Organization keywords lookup endpoint.

organization_web_technologiesArray of integers

To get a list of IDs use Web technologies lookup endpoint.

organization_founded_date_startstring(date)
organization_founded_date_endstring(date)
organization_employees_startinteger
organization_employees_endinteger
organization_revenue_startinteger
organization_revenue_endinteger
organization_domain_rank_startinteger
organization_domain_rank_endinteger
organization_linkedin_public_identifiersArray of strings

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/company/!slug!/".

funding_typesArray of strings(FundingTypesEnum)
Items Enum"angel""convertible_note""corporate_round""debt_financing""equity_crowdfunding""grant""initial_coin_offering""non_equity_assistance""post_ipo_debt""post_ipo_equity"
funding_total_startinteger
funding_total_endinteger
funding_event_date_featured_startstring(date)
funding_event_date_featured_endstring(date)
job_post_titlestring

This field supports a boolean text search query.

job_post_descriptionstring

This field supports a boolean text search query.

job_post_is_remoteboolean or null
job_post_is_activeboolean or null
job_post_date_featured_startstring(date)
job_post_date_featured_endstring(date)
job_post_locationsArray of integers

To get a list of IDs use Locations lookup endpoint.

job_post_locations_excludeArray of integers

To get a list of IDs use Locations lookup endpoint.

simple_event_sourcestring(SimpleEventSourceEnum)
  • product_hunt - Product Hunt
  • form_c_sec_gov - Form C sec.gov
  • form_d_sec_gov - Form D sec.gov
Enum"product_hunt""form_c_sec_gov""form_d_sec_gov"
simple_event_reasonstring(SimpleEventReasonEnum)
  • report_released - Report released
  • promoted_on_site - Promoted on site
Enum"report_released""promoted_on_site"
simple_event_date_featured_startstring(date)
simple_event_date_featured_endstring(date)
curl -i -X POST \
  'https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "page": 0,
    "role_title": "string",
    "role_description": "string",
    "role_is_current": true,
    "role_position_start_date": "2019-08-24",
    "role_position_end_date": "2019-08-24",
    "role_years_on_position_start": 0,
    "role_years_on_position_end": 0,
    "person_name": "string",
    "person_headline": "string",
    "person_description": "string",
    "person_skills": [
      0
    ],
    "person_locations": [
      0
    ],
    "person_industries": [
      0
    ],
    "person_industries_exclude": [
      0
    ],
    "person_linkedin_public_identifiers": [
      "string"
    ],
    "organizations": [
      0
    ],
    "organizations_bulk_domain": "string",
    "organization_domains": [
      "string"
    ],
    "organization_description": "string",
    "organization_locations": [
      0
    ],
    "organization_industries": [
      0
    ],
    "organization_industries_exclude": [
      0
    ],
    "organization_keywords": [
      0
    ],
    "organization_web_technologies": [
      0
    ],
    "organization_founded_date_start": "2019-08-24",
    "organization_founded_date_end": "2019-08-24",
    "organization_employees_start": 0,
    "organization_employees_end": 0,
    "organization_revenue_start": 0,
    "organization_revenue_end": 0,
    "organization_domain_rank_start": 0,
    "organization_domain_rank_end": 0,
    "organization_linkedin_public_identifiers": [
      "string"
    ],
    "funding_types": [
      "angel"
    ],
    "funding_total_start": 0,
    "funding_total_end": 0,
    "funding_event_date_featured_start": "2019-08-24",
    "funding_event_date_featured_end": "2019-08-24",
    "job_post_title": "string",
    "job_post_description": "string",
    "job_post_is_remote": true,
    "job_post_is_active": true,
    "job_post_date_featured_start": "2019-08-24",
    "job_post_date_featured_end": "2019-08-24",
    "job_post_locations": [
      0
    ],
    "job_post_locations_exclude": [
      0
    ],
    "simple_event_source": "product_hunt",
    "simple_event_reason": "report_released",
    "simple_event_date_featured_start": "2019-08-24",
    "simple_event_date_featured_end": "2019-08-24"
  }'

Responses

Bodyapplication/json
search_resultsArray of objects(OrganizationPersonRoleSearchResult)read-onlyrequired
search_results[].​idintegerread-onlyrequired
search_results[].​role_titlestring or null<= 255 characters
search_results[].​start_datestring or null(date)
search_results[].​end_datestring or null(date)
search_results[].​durationstring or null(Role duration)<= 255 characters
search_results[].​descriptionstring or null
search_results[].​is_currentboolean(Is current?)required
search_results[].​organizationobjectread-onlyrequired

Organization search result(With prefetch events) serializer.

search_results[].​organization.​idintegerread-onlyrequired
search_results[].​organization.​namestring<= 255 charactersrequired
search_results[].​organization.​legal_namestring<= 255 charactersrequired
search_results[].​organization.​websitestring or null(uri)<= 16384 characters
search_results[].​organization.​domainstring or null(uri)<= 200 characters
search_results[].​organization.​domain_rankinteger or nullread-onlyrequired

Domain rank.

search_results[].​organization.​logostring or null(uri)<= 510 characters
search_results[].​organization.​descriptionstring or null
search_results[].​organization.​founded_datestring or null(date)
search_results[].​organization.​operating_statusstring or null<= 255 characters
search_results[].​organization.​employees_rangestring or null<= 255 characters
search_results[].​organization.​employees_amountinteger or null[ 0 .. 2147483647 ]
search_results[].​organization.​keywordsArray of objects(OrganizationKeyword)read-onlyrequired
search_results[].​organization.​keywords[].​idintegerread-onlyrequired
search_results[].​organization.​keywords[].​namestring<= 255 charactersrequired
search_results[].​organization.​locationobjectread-onlyrequired

Serializer for the InnerLocation model.

search_results[].​organization.​location.​idintegerread-onlyrequired
search_results[].​organization.​location.​namestring<= 255 charactersrequired
search_results[].​organization.​location.​osm_locationsArray of objects(OSMLocation)read-onlyrequired
search_results[].​organization.​location.​osm_locations[].​idintegerread-onlyrequired
search_results[].​organization.​location.​osm_locations[].​namestring<= 255 charactersrequired
search_results[].​organization.​location.​osm_locations[].​place_typestring(Type)<= 255 charactersrequired
search_results[].​organization.​finance_infoobjectread-onlyrequired

Serializer for the OrganizationFinanceInfo model.

search_results[].​organization.​finance_info.​revenueinteger or null(int64)[ 0 .. 9223372036854776000 ]
search_results[].​organization.​linkedin_infoobjectread-onlyrequired

Serializer for the OrganizationLinkedinInfo model.

search_results[].​organization.​linkedin_info.​public_identifierstring or null<= 255 characters
search_results[].​organization.​linkedin_info.​industryobjectread-onlyrequired

Serializer for the LinkedinIndustry document.

search_results[].​organization.​linkedin_info.​industry.​idintegerread-onlyrequired
search_results[].​organization.​linkedin_info.​industry.​namestring<= 255 charactersrequired
search_results[].​organization.​linkedin_info.​public_profile_urlstring or nullread-onlyrequired

Get LinkedIn public profile URL.

search_results[].​organization.​addressesArray of objects(OrganizationAddress)read-onlyrequired
search_results[].​organization.​addresses[].​street_numberstring or null<= 255 characters
search_results[].​organization.​addresses[].​street_namestring or null<= 255 characters
search_results[].​organization.​addresses[].​citystring or null<= 255 characters
search_results[].​organization.​addresses[].​statestring or null(State/County)<= 255 characters
search_results[].​organization.​addresses[].​postcodestring or null(Post/Zip-code)<= 64 characters
search_results[].​organization.​addresses[].​countrystring<= 255 charactersrequired
search_results[].​organization.​addresses[].​summarystringrequired
search_results[].​organization.​date_updatedstring(date-time)read-onlyrequired
search_results[].​organization.​found_simple_eventsArray of objects(OrganizationSimpleEvent)required

Events will be available in case any event field would be used for the search. In results will be available 30 most recent matches.

search_results[].​organization.​found_simple_events[].​idintegerread-onlyrequired
search_results[].​organization.​found_simple_events[].​sourcestringread-onlyrequired
  • product_hunt - Product Hunt
  • form_c_sec_gov - Form C sec.gov
  • form_d_sec_gov - Form D sec.gov
Enum"product_hunt""form_c_sec_gov""form_d_sec_gov"
search_results[].​organization.​found_simple_events[].​date_featuredstring(date)required
search_results[].​organization.​found_simple_events[].​organization_idintegerread-onlyrequired
search_results[].​organization.​found_simple_events[].​reasonstring(ReasonEnum)required
  • report_released - Report released
  • promoted_on_site - Promoted on site
Enum"report_released""promoted_on_site"
search_results[].​organization.​found_simple_events[].​urlstring(uri)<= 255 charactersrequired
search_results[].​organization.​found_funding_eventsArray of objects(OrganizationFundingEvent)required

Events will be available in case any event field would be used for the search. In results will be available 30 most recent matches.

search_results[].​organization.​found_funding_events[].​idintegerread-onlyrequired
search_results[].​organization.​found_funding_events[].​sourcestringread-onlyrequired
  • crunchbase - Crunchbase
Value"crunchbase"
search_results[].​organization.​found_funding_events[].​date_featuredstring(date)required
search_results[].​organization.​found_funding_events[].​organization_idintegerread-onlyrequired
search_results[].​organization.​found_funding_events[].​funding_typestring<= 255 charactersrequired
search_results[].​organization.​found_funding_events[].​funding_totalinteger(int64)[ 0 .. 9223372036854776000 ]required
search_results[].​organization.​found_job_post_eventsArray of objects(OrganizationJobPostEvent)required

Events will be available in case any event field would be used for the search. In results will be available 30 most recent matches.

search_results[].​organization.​found_job_post_events[].​idintegerread-onlyrequired
search_results[].​organization.​found_job_post_events[].​sourcestringread-onlyrequired
  • indeed - Indeed
  • linkedin - LinkedIn
  • angellist - AngelList
Enum"indeed""linkedin""angellist"
search_results[].​organization.​found_job_post_events[].​date_featuredstring(date)required
search_results[].​organization.​found_job_post_events[].​organization_idintegerread-onlyrequired
search_results[].​organization.​found_job_post_events[].​source_idstring<= 65 charactersrequired
search_results[].​organization.​found_job_post_events[].​urlstring(uri)<= 510 charactersrequired
search_results[].​organization.​found_job_post_events[].​titlestring<= 255 charactersrequired
search_results[].​organization.​found_job_post_events[].​is_remoteboolean(Is remote?)required
search_results[].​organization.​found_job_post_events[].​is_activeboolean(Is active?)required
search_results[].​personobjectread-onlyrequired

Child serializer for the Person model.

search_results[].​person.​idintegerread-onlyrequired
search_results[].​person.​full_namestring<= 255 charactersrequired
search_results[].​person.​first_namestring<= 255 charactersrequired
search_results[].​person.​last_namestring or null<= 255 characters
search_results[].​person.​photostring or null(uri)<= 255 characters
search_results[].​person.​genderstring or null<= 255 characters
search_results[].​person.​headlinestring or null<= 255 characters
search_results[].​person.​descriptionstring or null
search_results[].​person.​skillsArray of objects(PersonSkill)read-onlyrequired
search_results[].​person.​skills[].​namestring<= 255 charactersrequired
search_results[].​person.​locationobjectread-onlyrequired

Serializer for the InnerLocation model.

search_results[].​person.​location.​idintegerread-onlyrequired
search_results[].​person.​location.​namestring<= 255 charactersrequired
search_results[].​person.​location.​osm_locationsArray of objects(OSMLocation)read-onlyrequired
search_results[].​person.​location.​osm_locations[].​idintegerread-onlyrequired
search_results[].​person.​location.​osm_locations[].​namestring<= 255 charactersrequired
search_results[].​person.​location.​osm_locations[].​place_typestring(Type)<= 255 charactersrequired
search_results[].​person.​linkedin_infoobjectread-onlyrequired

Serializer for the PersonLinkedinInfo model.

search_results[].​person.​linkedin_info.​public_identifierstring or null<= 255 characters
search_results[].​person.​linkedin_info.​industryobjectread-onlyrequired

Serializer for the LinkedinIndustry document.

search_results[].​person.​linkedin_info.​industry.​idintegerread-onlyrequired
search_results[].​person.​linkedin_info.​industry.​namestring<= 255 charactersrequired
search_results[].​person.​linkedin_info.​public_profile_urlstringread-onlyrequired

Get LinkedIn public profile URL.

search_results[].​person.​date_updatedstring(date-time)read-onlyrequired
search_results[].​date_updatedstring(date-time)read-onlyrequired
total_search_resultsinteger>= 0required
Response
application/json
{
  "search_results": [
    { … }
  ],
  "total_search_results": 0
}

Person role search totals

Request

Organization person role search totals.

Security
Api-Key
Path
account_idintegerrequired
Body
pageinteger
role_titlestring

This field supports a boolean text search query.

role_descriptionstring

This field supports a boolean text search query.

role_is_currentboolean
Default true
role_position_start_datestring(date)
role_position_end_datestring(date)
role_years_on_position_startinteger
role_years_on_position_endinteger
person_namestring

This field supports a boolean text search query.

person_headlinestring

This field supports a boolean text search query.

person_descriptionstring

This field supports a boolean text search query.

person_skillsArray of integers

To get a list of IDs use Person skills lookup endpoint.

person_locationsArray of integers

To get a list of IDs use Locations lookup endpoint.

person_industriesArray of integers

To get a list of IDs use Industries lookup endpoint.

person_industries_excludeArray of integers

To get a list of IDs use Industries lookup endpoint.

person_linkedin_public_identifiersArray of strings

LinkedIn person "Public identifier/Slug/ID" - "linkedin.com/in/!slug!/".

organizationsArray of integers

To get a list of IDs use Organizations lookup endpoint.

organizations_bulk_domainstring
organization_domainsArray of strings
organization_descriptionstring

This field supports a boolean text search query.

organization_locationsArray of integers

To get a list of IDs use Locations lookup endpoint.

organization_industriesArray of integers

To get a list of IDs use Industries lookup endpoint.

organization_industries_excludeArray of integers

To get a list of IDs use Industries lookup endpoint.

organization_keywordsArray of integers

To get a list of IDs use Organization keywords lookup endpoint.

organization_web_technologiesArray of integers

To get a list of IDs use Web technologies lookup endpoint.

organization_founded_date_startstring(date)
organization_founded_date_endstring(date)
organization_employees_startinteger
organization_employees_endinteger
organization_revenue_startinteger
organization_revenue_endinteger
organization_domain_rank_startinteger
organization_domain_rank_endinteger
organization_linkedin_public_identifiersArray of strings

LinkedIn organization "Public identifier/Slug/ID" - "linkedin.com/company/!slug!/".

funding_typesArray of strings(FundingTypesEnum)
Items Enum"angel""convertible_note""corporate_round""debt_financing""equity_crowdfunding""grant""initial_coin_offering""non_equity_assistance""post_ipo_debt""post_ipo_equity"
funding_total_startinteger
funding_total_endinteger
funding_event_date_featured_startstring(date)
funding_event_date_featured_endstring(date)
job_post_titlestring

This field supports a boolean text search query.

job_post_descriptionstring

This field supports a boolean text search query.

job_post_is_remoteboolean or null
job_post_is_activeboolean or null
job_post_date_featured_startstring(date)
job_post_date_featured_endstring(date)
job_post_locationsArray of integers

To get a list of IDs use Locations lookup endpoint.

job_post_locations_excludeArray of integers

To get a list of IDs use Locations lookup endpoint.

simple_event_sourcestring(SimpleEventSourceEnum)
  • product_hunt - Product Hunt
  • form_c_sec_gov - Form C sec.gov
  • form_d_sec_gov - Form D sec.gov
Enum"product_hunt""form_c_sec_gov""form_d_sec_gov"
simple_event_reasonstring(SimpleEventReasonEnum)
  • report_released - Report released
  • promoted_on_site - Promoted on site
Enum"report_released""promoted_on_site"
simple_event_date_featured_startstring(date)
simple_event_date_featured_endstring(date)
curl -i -X POST \
  'https://api-v2.forager.ai/api/{account_id}/datastorage/person_role_search/totals/' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "page": 0,
    "role_title": "string",
    "role_description": "string",
    "role_is_current": true,
    "role_position_start_date": "2019-08-24",
    "role_position_end_date": "2019-08-24",
    "role_years_on_position_start": 0,
    "role_years_on_position_end": 0,
    "person_name": "string",
    "person_headline": "string",
    "person_description": "string",
    "person_skills": [
      0
    ],
    "person_locations": [
      0
    ],
    "person_industries": [
      0
    ],
    "person_industries_exclude": [
      0
    ],
    "person_linkedin_public_identifiers": [
      "string"
    ],
    "organizations": [
      0
    ],
    "organizations_bulk_domain": "string",
    "organization_domains": [
      "string"
    ],
    "organization_description": "string",
    "organization_locations": [
      0
    ],
    "organization_industries": [
      0
    ],
    "organization_industries_exclude": [
      0
    ],
    "organization_keywords": [
      0
    ],
    "organization_web_technologies": [
      0
    ],
    "organization_founded_date_start": "2019-08-24",
    "organization_founded_date_end": "2019-08-24",
    "organization_employees_start": 0,
    "organization_employees_end": 0,
    "organization_revenue_start": 0,
    "organization_revenue_end": 0,
    "organization_domain_rank_start": 0,
    "organization_domain_rank_end": 0,
    "organization_linkedin_public_identifiers": [
      "string"
    ],
    "funding_types": [
      "angel"
    ],
    "funding_total_start": 0,
    "funding_total_end": 0,
    "funding_event_date_featured_start": "2019-08-24",
    "funding_event_date_featured_end": "2019-08-24",
    "job_post_title": "string",
    "job_post_description": "string",
    "job_post_is_remote": true,
    "job_post_is_active": true,
    "job_post_date_featured_start": "2019-08-24",
    "job_post_date_featured_end": "2019-08-24",
    "job_post_locations": [
      0
    ],
    "job_post_locations_exclude": [
      0
    ],
    "simple_event_source": "product_hunt",
    "simple_event_reason": "report_released",
    "simple_event_date_featured_start": "2019-08-24",
    "simple_event_date_featured_end": "2019-08-24"
  }'

Responses

Bodyapplication/json
total_search_resultsinteger>= 0required
total_personsinteger>= 0required
total_organizationsinteger>= 0required
Response
application/json
{
  "total_search_results": 0,
  "total_persons": 0,
  "total_organizations": 0
}

Websites

Operations

Users

Operations

Autocomplete

Operations