Forager: Person Role Search

The Person Role Search endpoint lets you search for individuals based on their roles, titles, time periods, and associated organizations.

Tool ID: forager_person_role_search

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'forager_person_role_search',
  {
    "page": 123,
    "role_title": "example",
    "role_description": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute forager_person_role_search --input '{
  "page": 123,
  "role_title": "example",
  "role_description": "example"
}' --json

Example response

The static output schema is not detailed enough to generate a reliable example. Use deepline tools get forager_person_role_search --json for the complete live contract.

Input reference

OrganizationPersonRole search request serializer.

Name	Type	Required	Default	Details
`payload.page`	`integer`	No	—	—
`payload.role_title`	`string`	No	—	This field supports a boolean text search query.
`payload.role_description`	`string`	No	—	This field supports a boolean text search query.
`payload.role_is_current`	`boolean`	No	`true`	—
`payload.role_position_start_date`	`string`	No	—	Format: `date`.
`payload.role_position_end_date`	`string`	No	—	Format: `date`.
`payload.role_years_on_position_start`	`integer`	No	—	—
`payload.role_years_on_position_end`	`integer`	No	—	—
`payload.person_name`	`string`	No	—	This field supports a boolean text search query.
`payload.person_headline`	`string`	No	—	This field supports a boolean text search query.
`payload.person_description`	`string`	No	—	This field supports a boolean text search query.
`payload.person_skills`	`array`	No	—	To get a list of IDs use Person skills lookup endpoint .
`payload.person_locations`	`array`	No	—	To get a list of IDs use Locations lookup endpoint .
`payload.person_industries`	`array`	No	—	To get a list of IDs use Industries lookup endpoint .
`payload.person_industries_exclude`	`array`	No	—	To get a list of IDs use Industries lookup endpoint .
`payload.person_linkedin_public_identifiers`	`array`	No	—	LinkedIn person “Public identifier/Slug/ID” - “linkedin.com/in/!slug!/”.
`payload.organizations`	`array`	No	—	To get a list of IDs use Organizations lookup endpoint .
`payload.organizations_bulk_domain`	`string`	No	—	—
`payload.organization_domains`	`array`	No	—	—
`payload.organization_description`	`string`	No	—	This field supports a boolean text search query.
`payload.organization_locations`	`array`	No	—	To get a list of IDs use Locations lookup endpoint .
`payload.organization_industries`	`array`	No	—	To get a list of IDs use Industries lookup endpoint .
`payload.organization_industries_exclude`	`array`	No	—	To get a list of IDs use Industries lookup endpoint .
`payload.organization_keywords`	`array`	No	—	To get a list of IDs use Organization keywords lookup endpoint .
`payload.organization_web_technologies`	`array`	No	—	To get a list of IDs use Web technologies lookup endpoint .
`payload.organization_founded_date_start`	`string`	No	—	Format: `date`.
`payload.organization_founded_date_end`	`string`	No	—	Format: `date`.
`payload.organization_employees_start`	`integer`	No	—	—
`payload.organization_employees_end`	`integer`	No	—	—
`payload.organization_revenue_start`	`integer`	No	—	—
`payload.organization_revenue_end`	`integer`	No	—	—
`payload.organization_domain_rank_start`	`integer`	No	—	—
`payload.organization_domain_rank_end`	`integer`	No	—	—
`payload.organization_linkedin_public_identifiers`	`array`	No	—	LinkedIn organization “Public identifier/Slug/ID” - “linkedin.com/company/!slug!/”.
`payload.funding_types`	`array`	No	—	—
`payload.funding_total_start`	`integer`	No	—	—
`payload.funding_total_end`	`integer`	No	—	—
`payload.funding_event_date_featured_start`	`string`	No	—	Format: `date`.
`payload.funding_event_date_featured_end`	`string`	No	—	Format: `date`.
`payload.job_post_title`	`string`	No	—	This field supports a boolean text search query.
`payload.job_post_description`	`string`	No	—	This field supports a boolean text search query.
`payload.job_post_is_remote`	`boolean`	No	—	—
`payload.job_post_is_active`	`boolean`	No	—	—
`payload.job_post_date_featured_start`	`string`	No	—	Format: `date`.
`payload.job_post_date_featured_end`	`string`	No	—	Format: `date`.
`payload.job_post_locations`	`array`	No	—	To get a list of IDs use Locations lookup endpoint .
`payload.job_post_locations_exclude`	`array`	No	—	To get a list of IDs use Locations lookup endpoint .
`payload.simple_event_source`	`"product_hunt" \| "form_c_sec_gov" \| "form_d_sec_gov"`	No	—	* `product_hunt` - Product Hunt * `form_c_sec_gov` - Form C sec.gov * `form_d_sec_gov` - Form D sec.gov Allowed: `product_hunt`, `form_c_sec_gov`, `form_d_sec_gov`.
`payload.simple_event_reason`	`"report_released" \| "promoted_on_site"`	No	—	* `report_released` - Report released * `promoted_on_site` - Promoted on site Allowed: `report_released`, `promoted_on_site`.
`payload.simple_event_date_featured_start`	`string`	No	—	Format: `date`.
`payload.simple_event_date_featured_end`	`string`	No	—	Format: `date`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	OrganizationPersonRole search response serializer.
`result.data.search_results`	`array`	Yes	—	—
`result.data.search_results[].id`	`integer`	Yes	—	—
`result.data.search_results[].role_title`	`string \| null`	No	—	Maximum length: 255.
`result.data.search_results[].start_date`	`string \| null`	No	—	Format: `date`.
`result.data.search_results[].end_date`	`string \| null`	No	—	Format: `date`.
`result.data.search_results[].duration`	`string \| null`	No	—	Maximum length: 255.
`result.data.search_results[].description`	`string \| null`	No	—	—
`result.data.search_results[].is_current`	`boolean`	Yes	—	—
`result.data.search_results[].organization`	`object`	Yes	—	Organization search result(With prefetch events) serializer.
`result.data.search_results[].organization.id`	`integer`	Yes	—	—
`result.data.search_results[].organization.name`	`string`	Yes	—	Maximum length: 255.
`result.data.search_results[].organization.legal_name`	`string`	Yes	—	Maximum length: 255.
`result.data.search_results[].organization.website`	`string \| null`	No	—	Format: `uri`. Maximum length: 16384.
`result.data.search_results[].organization.domain`	`string \| null`	No	—	Format: `uri`. Maximum length: 200.
`result.data.search_results[].organization.domain_rank`	`integer \| null`	Yes	—	Domain rank.
`result.data.search_results[].organization.logo`	`string \| null`	No	—	Format: `uri`. Maximum length: 510.
`result.data.search_results[].organization.description`	`string \| null`	No	—	—
`result.data.search_results[].organization.founded_date`	`string \| null`	No	—	Format: `date`.
`result.data.search_results[].organization.operating_status`	`string \| null`	No	—	Maximum length: 255.
`result.data.search_results[].organization.employees_range`	`string \| null`	No	—	Maximum length: 255.
`result.data.search_results[].organization.employees_amount`	`integer \| null`	No	—	Minimum: 0. Maximum: 2147483647.
`result.data.search_results[].organization.keywords`	`array`	Yes	—	—
`result.data.search_results[].organization.keywords[].id`	`integer`	Yes	—	—
`result.data.search_results[].organization.keywords[].name`	`string`	Yes	—	Maximum length: 255.
`result.data.search_results[].organization.location`	`object`	Yes	—	Serializer for the InnerLocation model.
`result.data.search_results[].organization.location.id`	`integer`	Yes	—	—
`result.data.search_results[].organization.location.name`	`string`	Yes	—	Maximum length: 255.
`result.data.search_results[].organization.location.osm_locations`	`array`	Yes	—	—
`result.data.search_results[].organization.location.osm_locations[].id`	`integer`	Yes	—	—
`result.data.search_results[].organization.location.osm_locations[].name`	`string`	Yes	—	Maximum length: 255.
`result.data.search_results[].organization.location.osm_locations[].place_type`	`string`	Yes	—	Maximum length: 255.
`result.data.search_results[].organization.finance_info`	`object`	Yes	—	Serializer for the OrganizationFinanceInfo model.
`result.data.search_results[].organization.finance_info.revenue`	`integer \| null`	No	—	Format: `int64`. Minimum: 0. Maximum: 9223372036854776000.
`result.data.search_results[].organization.linkedin_info`	`object`	Yes	—	Serializer for the OrganizationLinkedinInfo model.
`result.data.search_results[].organization.linkedin_info.public_identifier`	`string \| null`	No	—	Maximum length: 255.
`result.data.search_results[].organization.linkedin_info.industry`	`object`	Yes	—	Serializer for the LinkedinIndustry document.
`result.data.search_results[].organization.linkedin_info.industry.id`	`integer`	Yes	—	—
`result.data.search_results[].organization.linkedin_info.industry.name`	`string`	Yes	—	Maximum length: 255.
`result.data.search_results[].organization.linkedin_info.public_profile_url`	`string \| null`	Yes	—	Get LinkedIn public profile URL.
`result.data.search_results[].organization.addresses`	`array`	Yes	—	—
`result.data.search_results[].organization.addresses[].street_number`	`string \| null`	No	—	Maximum length: 255.
`result.data.search_results[].organization.addresses[].street_name`	`string \| null`	No	—	Maximum length: 255.
`result.data.search_results[].organization.addresses[].city`	`string \| null`	No	—	Maximum length: 255.
`result.data.search_results[].organization.addresses[].state`	`string \| null`	No	—	Maximum length: 255.
`result.data.search_results[].organization.addresses[].postcode`	`string \| null`	No	—	Maximum length: 64.
`result.data.search_results[].organization.addresses[].country`	`string`	Yes	—	Maximum length: 255.
`result.data.search_results[].organization.addresses[].summary`	`string`	Yes	—	—
`result.data.search_results[].organization.date_updated`	`string`	Yes	—	Format: `date-time`.
`result.data.search_results[].organization.found_simple_events`	`array`	Yes	—	Events will be available in case any event field would be used for the search. In results will be available 30 most recent matches.

The table shows the first 50 fields. Expand the raw schema below for every field.

This output schema is too large to embed without slowing the page. Get the complete live contract with deepline tools get forager_person_role_search --json.

Deepline cost

Pricing model: per_page (per page).
Estimated Deepline credits: 0.32 per pricing unit.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Forager: Person Role Search

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation