> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Forager Person Role Search: Inputs, Cost & CLI Example
> The Person Role Search endpoint lets you search for individuals based on their roles, titles, time periods, and associated organizations.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=forager_person_role_search:{}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| -------------------------------------------------- | -------------------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------- |
| `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 | | |
| `payload.role_position_end_date` | `string` | No | | |
| `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 | | |
| `payload.organization_founded_date_end` | `string` | No | | |
| `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 | | |
| `payload.funding_event_date_featured_end` | `string` | No | | |
| `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 | | |
| `payload.job_post_date_featured_end` | `string` | No | | |
| `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 |
| `payload.simple_event_reason` | `"report_released" \| "promoted_on_site"` | No | | \* `report_released` - Report released \* `promoted_on_site` - Promoted on site |
| `payload.simple_event_date_featured_start` | `string` | No | | |
| `payload.simple_event_date_featured_end` | `string` | No | | |
### Allowed values
| Field | Allowed values |
| ----------------------------- | -------------------------------------------------- |
| `payload.simple_event_source` | `product_hunt`, `form_c_sec_gov`, `form_d_sec_gov` |
| `payload.simple_event_reason` | `report_released`, `promoted_on_site` |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "OrganizationPersonRole search request serializer.",
"properties": {
"page": {
"type": "integer"
},
"role_title": {
"type": "string",
"description": "This field supports a boolean text search query."
},
"role_description": {
"type": "string",
"description": "This field supports a boolean text search query."
},
"role_is_current": {
"type": "boolean",
"default": true
},
"role_position_start_date": {
"type": "string",
"format": "date"
},
"role_position_end_date": {
"type": "string",
"format": "date"
},
"role_years_on_position_start": {
"type": "integer"
},
"role_years_on_position_end": {
"type": "integer"
},
"person_name": {
"type": "string",
"description": "This field supports a boolean text search query."
},
"person_headline": {
"type": "string",
"description": "This field supports a boolean text search query."
},
"person_description": {
"type": "string",
"description": "This field supports a boolean text search query."
},
"person_skills": {
"type": "array",
"description": "To get a list of IDs use Person skills lookup endpoint .",
"items": {
"type": "integer"
}
},
"person_locations": {
"type": "array",
"description": "To get a list of IDs use Locations lookup endpoint .",
"items": {
"type": "integer"
}
},
"person_industries": {
"type": "array",
"description": "To get a list of IDs use Industries lookup endpoint .",
"items": {
"type": "integer"
}
},
"person_industries_exclude": {
"type": "array",
"description": "To get a list of IDs use Industries lookup endpoint .",
"items": {
"type": "integer"
}
},
"person_linkedin_public_identifiers": {
"type": "array",
"description": "LinkedIn person \"Public identifier/Slug/ID\" - \"linkedin.com/in/!slug!/\".",
"items": {
"type": "string"
}
},
"organizations": {
"type": "array",
"description": "To get a list of IDs use Organizations lookup endpoint .",
"items": {
"type": "integer"
}
},
"organizations_bulk_domain": {
"type": "string"
},
"organization_domains": {
"type": "array",
"items": {
"type": "string",
"description": "This field supports a boolean text search query."
}
},
"organization_description": {
"type": "string",
"description": "This field supports a boolean text search query."
},
"organization_locations": {
"type": "array",
"description": "To get a list of IDs use Locations lookup endpoint .",
"items": {
"type": "integer"
}
},
"organization_industries": {
"type": "array",
"description": "To get a list of IDs use Industries lookup endpoint .",
"items": {
"type": "integer"
}
},
"organization_industries_exclude": {
"type": "array",
"description": "To get a list of IDs use Industries lookup endpoint .",
"items": {
"type": "integer"
}
},
"organization_keywords": {
"type": "array",
"description": "To get a list of IDs use Organization keywords lookup endpoint .",
"items": {
"type": "integer"
}
},
"organization_web_technologies": {
"type": "array",
"description": "To get a list of IDs use Web technologies lookup endpoint .",
"items": {
"type": "integer"
}
},
"organization_founded_date_start": {
"type": "string",
"format": "date"
},
"organization_founded_date_end": {
"type": "string",
"format": "date"
},
"organization_employees_start": {
"type": "integer"
},
"organization_employees_end": {
"type": "integer"
},
"organization_revenue_start": {
"type": "integer"
},
"organization_revenue_end": {
"type": "integer"
},
"organization_domain_rank_start": {
"type": "integer"
},
"organization_domain_rank_end": {
"type": "integer"
},
"organization_linkedin_public_identifiers": {
"type": "array",
"description": "LinkedIn organization \"Public identifier/Slug/ID\" - \"linkedin.com/company/!slug!/\".",
"items": {
"type": "string"
}
},
"funding_types": {
"type": "array",
"items": {
"type": "string",
"description": "* `angel` - Angel * `convertible_note` - Convertible Note * `corporate_round` - Corporate Round * `debt_financing` - Debt Financing * `equity_crowdfunding` - Equity Crowdfunding * `grant` - Grant * `initial_coin_offering` - Initial coin offering (ICO) * `non_equity_assistance` - Non-Equity Assistance * `post_ipo_debt` - Post-IPO Debt * `post_ipo_equity` - Post-IPO Equity * `post_ipo_secondary` - Post-IPO Secondary * `pre_seed` - Pre-Seed * `private_equity` - Private Equity * `product_crowdfunding` - Product Crowdfunding * `secondary_market` - Secondary Market * `seed` - Seed * `series_a` - Series A * `series_b` - Series B * `series_c` - Series C * `series_d` - Series D * `series_e` - Series E * `series_f` - Series F * `series_g` - Series G * `series_h` - Series H * `series_i` - Series I * `series_j` - Series J * `series_unknown` - Venture - Series Unknown * `undisclosed` - Undisclosed",
"enum": [
"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"
]
}
},
"funding_total_start": {
"type": "integer"
},
"funding_total_end": {
"type": "integer"
},
"funding_event_date_featured_start": {
"type": "string",
"format": "date"
},
"funding_event_date_featured_end": {
"type": "string",
"format": "date"
},
"job_post_title": {
"type": "string",
"description": "This field supports a boolean text search query."
},
"job_post_description": {
"type": "string",
"description": "This field supports a boolean text search query."
},
"job_post_is_remote": {
"type": [
"boolean",
"null"
]
},
"job_post_is_active": {
"type": [
"boolean",
"null"
]
},
"job_post_date_featured_start": {
"type": "string",
"format": "date"
},
"job_post_date_featured_end": {
"type": "string",
"format": "date"
},
"job_post_locations": {
"type": "array",
"description": "To get a list of IDs use Locations lookup endpoint .",
"items": {
"type": "integer"
}
},
"job_post_locations_exclude": {
"type": "array",
"description": "To get a list of IDs use Locations lookup endpoint .",
"items": {
"type": "integer"
}
},
"simple_event_source": {
"type": "string",
"description": "* `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_reason": {
"type": "string",
"description": "* `report_released` - Report released * `promoted_on_site` - Promoted on site",
"enum": [
"report_released",
"promoted_on_site"
]
},
"simple_event_date_featured_start": {
"type": "string",
"format": "date"
},
"simple_event_date_featured_end": {
"type": "string",
"format": "date"
}
},
"required": [],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | -------------------------------------------------- |
| `result.data` | `object` | Yes | | OrganizationPersonRole search response serializer. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "OrganizationPersonRole search response serializer.",
"properties": {
"search_results": {
"type": "array",
"items": {
"type": "object",
"description": "Serializer for OrganizationPersonRole search results.",
"properties": {
"id": {
"type": "integer"
},
"role_title": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"start_date": {
"type": [
"string",
"null"
],
"format": "date"
},
"end_date": {
"type": [
"string",
"null"
],
"format": "date"
},
"duration": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"is_current": {
"type": "boolean"
},
"organization": {
"type": "object",
"description": "Organization search result(With prefetch events) serializer.",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string",
"maxLength": 255
},
"legal_name": {
"type": "string",
"maxLength": 255
},
"website": {
"type": [
"string",
"null"
],
"maxLength": 16384,
"format": "uri"
},
"domain": {
"type": [
"string",
"null"
],
"maxLength": 200,
"format": "uri"
},
"domain_rank": {
"type": [
"integer",
"null"
],
"description": "Domain rank."
},
"logo": {
"type": [
"string",
"null"
],
"maxLength": 510,
"format": "uri"
},
"description": {
"type": [
"string",
"null"
]
},
"founded_date": {
"type": [
"string",
"null"
],
"format": "date"
},
"operating_status": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"employees_range": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"employees_amount": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 2147483647
},
"keywords": {
"type": "array",
"items": {
"type": "object",
"description": "Serializer for the OrganizationKeyword model.",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string",
"maxLength": 255
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"location": {
"type": "object",
"description": "Serializer for the InnerLocation model.",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string",
"maxLength": 255
},
"osm_locations": {
"type": "array",
"items": {
"type": "object",
"description": "Serializer for the OSMLocation model.",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string",
"maxLength": 255
},
"place_type": {
"type": "string",
"maxLength": 255
}
},
"required": [
"id",
"name",
"place_type"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"osm_locations"
],
"additionalProperties": false
},
"finance_info": {
"type": "object",
"description": "Serializer for the OrganizationFinanceInfo model.",
"properties": {
"revenue": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 9223372036854776000,
"format": "int64"
}
},
"additionalProperties": false
},
"linkedin_info": {
"type": "object",
"description": "Serializer for the OrganizationLinkedinInfo model.",
"properties": {
"public_identifier": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"industry": {
"type": "object",
"description": "Serializer for the LinkedinIndustry document.",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string",
"maxLength": 255
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"public_profile_url": {
"type": [
"string",
"null"
],
"description": "Get LinkedIn public profile URL."
}
},
"required": [
"industry",
"public_profile_url"
],
"additionalProperties": false
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"description": "Serializer for the OrganizationAddress model.",
"properties": {
"street_number": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"street_name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"city": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"state": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"postcode": {
"type": [
"string",
"null"
],
"maxLength": 64
},
"country": {
"type": "string",
"maxLength": 255
},
"summary": {
"type": "string"
}
},
"required": [
"country",
"summary"
],
"additionalProperties": false
}
},
"date_updated": {
"type": "string",
"format": "date-time"
},
"found_simple_events": {
"type": "array",
"description": "Events will be available in case any event field would be used for the search. In results will be available 30 most recent matches.",
"items": {
"type": "object",
"description": "Serializer for the OrganizationSimpleEvent model.",
"properties": {
"id": {
"type": "integer"
},
"source": {
"type": "string",
"description": "* `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"
]
},
"date_featured": {
"type": "string",
"format": "date"
},
"organization_id": {
"type": "integer"
},
"reason": {
"type": "string",
"description": "* `report_released` - Report released * `promoted_on_site` - Promoted on site",
"enum": [
"report_released",
"promoted_on_site"
]
},
"url": {
"type": "string",
"maxLength": 255,
"format": "uri"
}
},
"required": [
"date_featured",
"id",
"organization_id",
"reason",
"source",
"url"
],
"additionalProperties": false
}
},
"found_funding_events": {
"type": "array",
"description": "Events will be available in case any event field would be used for the search. In results will be available 30 most recent matches.",
"items": {
"type": "object",
"description": "Serializer for the OrganizationFundingEvent model.",
"properties": {
"id": {
"type": "integer"
},
"source": {
"type": "string",
"description": "* `crunchbase` - Crunchbase",
"enum": [
"crunchbase"
]
},
"date_featured": {
"type": "string",
"format": "date"
},
"organization_id": {
"type": "integer"
},
"funding_type": {
"type": "string",
"maxLength": 255
},
"funding_total": {
"type": "integer",
"minimum": 0,
"maximum": 9223372036854776000,
"format": "int64"
}
},
"required": [
"date_featured",
"funding_total",
"funding_type",
"id",
"organization_id",
"source"
],
"additionalProperties": false
}
},
"found_job_post_events": {
"type": "array",
"description": "Events will be available in case any event field would be used for the search. In results will be available 30 most recent matches.",
"items": {
"type": "object",
"description": "Serializer for the OrganizationJobPostEvent model.",
"properties": {
"id": {
"type": "integer"
},
"source": {
"type": "string",
"description": "* `indeed` - Indeed * `linkedin` - LinkedIn * `angellist` - AngelList",
"enum": [
"indeed",
"linkedin",
"angellist"
]
},
"date_featured": {
"type": "string",
"format": "date"
},
"organization_id": {
"type": "integer"
},
"source_id": {
"type": "string",
"maxLength": 65
},
"url": {
"type": "string",
"maxLength": 510,
"format": "uri"
},
"title": {
"type": "string",
"maxLength": 255
},
"is_remote": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"date_featured",
"id",
"is_active",
"is_remote",
"organization_id",
"source",
"source_id",
"title",
"url"
],
"additionalProperties": false
}
}
},
"required": [
"addresses",
"date_updated",
"domain_rank",
"finance_info",
"found_funding_events",
"found_job_post_events",
"found_simple_events",
"id",
"keywords",
"legal_name",
"linkedin_info",
"location",
"name"
],
"additionalProperties": false
},
"person": {
"type": "object",
"description": "Child serializer for the Person model.",
"properties": {
"id": {
"type": "integer"
},
"full_name": {
"type": "string",
"maxLength": 255
},
"first_name": {
"type": "string",
"maxLength": 255
},
"last_name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"photo": {
"type": [
"string",
"null"
],
"maxLength": 255,
"format": "uri"
},
"gender": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"headline": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"skills": {
"type": "array",
"items": {
"type": "object",
"description": "Serializer for the PersonSkill model.",
"properties": {
"name": {
"type": "string",
"maxLength": 255
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"location": {
"type": "object",
"description": "Serializer for the InnerLocation model.",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string",
"maxLength": 255
},
"osm_locations": {
"type": "array",
"items": {
"type": "object",
"description": "Serializer for the OSMLocation model.",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string",
"maxLength": 255
},
"place_type": {
"type": "string",
"maxLength": 255
}
},
"required": [
"id",
"name",
"place_type"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"osm_locations"
],
"additionalProperties": false
},
"linkedin_info": {
"type": "object",
"description": "Serializer for the PersonLinkedinInfo model.",
"properties": {
"public_identifier": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"industry": {
"type": "object",
"description": "Serializer for the LinkedinIndustry document.",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string",
"maxLength": 255
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"public_profile_url": {
"type": "string",
"description": "Get LinkedIn public profile URL."
}
},
"required": [
"industry",
"public_profile_url"
],
"additionalProperties": false
},
"date_updated": {
"type": "string",
"format": "date-time"
}
},
"required": [
"date_updated",
"first_name",
"full_name",
"id",
"linkedin_info",
"location",
"skills"
],
"additionalProperties": false
},
"date_updated": {
"type": "string",
"format": "date-time"
}
},
"required": [
"date_updated",
"id",
"is_current",
"organization",
"person"
],
"additionalProperties": false
}
},
"total_search_results": {
"type": "integer",
"minimum": 0
}
},
"required": [
"search_results",
"total_search_results"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute forager_person_role_search --payload '{}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `per_page` (per page).
* Estimated Deepline credits: `0.32` per pricing unit.
* Billing mode: `post_deduct`.