Skip to content
/
Person role search

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
funding_total_startinteger
funding_total_endinteger
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"
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
total_search_resultsinteger, >= 0required
Response
{
  "search_results": [
    { … }
  ],
  "total_search_results": 0
}