Tool ID:
forager_organization_searchRun this action
Use the TypeScript SDK for a single call. Putctx.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_organization_search',
{
"page": 123,
"organization_ids": [
123
],
"description": "Example description"
},
);
console.log(result.toolResponse.raw);
CLI
deepline tools execute forager_organization_search --input '{
"page": 123,
"organization_ids": [
123
],
"description": "Example description"
}' --json
Example response
The static output schema is not detailed enough to generate a reliable example. Usedeepline tools get forager_organization_search --json for the complete live contract.
Input reference
Organization search request serializer.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
payload.page | integer | No | — | — |
payload.organization_ids | array | No | — | To get a list of IDs use Organizations lookup endpoint . |
payload.description | string | No | — | — |
payload.locations | array | No | — | To get a list of IDs use Locations lookup endpoint . |
payload.industries | array | No | — | To get a list of IDs use Industries lookup endpoint . |
payload.industries_exclude | array | No | — | To get a list of IDs use Industries lookup endpoint . |
payload.keywords | array | No | — | To get a list of IDs use Organization keywords lookup endpoint . |
payload.employees_start | integer | No | — | — |
payload.employees_end | integer | No | — | — |
payload.founded_date_start | string | No | — | Format: date. |
payload.founded_date_end | string | No | — | Format: date. |
payload.revenue_start | integer | No | — | — |
payload.revenue_end | integer | No | — | — |
payload.domains | array | No | — | — |
payload.domain_rank_start | integer | No | — | — |
payload.domain_rank_end | integer | No | — | — |
payload.domain_traffic_start | integer | No | — | — |
payload.domain_traffic_end | integer | No | — | — |
payload.web_technologies | array | No | — | To get a list of IDs use Organization keywords lookup endpoint . |
payload.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 | — | Organization search response serializer. |
result.data.search_results | array | Yes | — | — |
result.data.search_results[].id | integer | Yes | — | — |
result.data.search_results[].name | string | Yes | — | Maximum length: 255. |
result.data.search_results[].legal_name | string | Yes | — | Maximum length: 255. |
result.data.search_results[].website | string | null | No | — | Format: uri. Maximum length: 16384. |
result.data.search_results[].domain | string | null | No | — | Format: uri. Maximum length: 200. |
result.data.search_results[].domain_rank | integer | null | Yes | — | Domain rank. |
result.data.search_results[].logo | string | null | No | — | Format: uri. Maximum length: 510. |
result.data.search_results[].description | string | null | No | — | — |
result.data.search_results[].founded_date | string | null | No | — | Format: date. |
result.data.search_results[].operating_status | string | null | No | — | Maximum length: 255. |
result.data.search_results[].employees_range | string | null | No | — | Maximum length: 255. |
result.data.search_results[].employees_amount | integer | null | No | — | Minimum: 0. Maximum: 2147483647. |
result.data.search_results[].keywords | array | Yes | — | — |
result.data.search_results[].keywords[].id | integer | Yes | — | — |
result.data.search_results[].keywords[].name | string | Yes | — | Maximum length: 255. |
result.data.search_results[].location | object | Yes | — | Serializer for the InnerLocation model. |
result.data.search_results[].location.id | integer | Yes | — | — |
result.data.search_results[].location.name | string | Yes | — | Maximum length: 255. |
result.data.search_results[].location.osm_locations | array | Yes | — | — |
result.data.search_results[].location.osm_locations[].id | integer | Yes | — | — |
result.data.search_results[].location.osm_locations[].name | string | Yes | — | Maximum length: 255. |
result.data.search_results[].location.osm_locations[].place_type | string | Yes | — | Maximum length: 255. |
result.data.search_results[].finance_info | object | Yes | — | Serializer for the OrganizationFinanceInfo model. |
result.data.search_results[].finance_info.revenue | integer | null | No | — | Format: int64. Minimum: 0. Maximum: 9223372036854776000. |
result.data.search_results[].linkedin_info | object | Yes | — | Serializer for the OrganizationLinkedinInfo model. |
result.data.search_results[].linkedin_info.public_identifier | string | null | No | — | Maximum length: 255. |
result.data.search_results[].linkedin_info.industry | object | Yes | — | Serializer for the LinkedinIndustry document. |
result.data.search_results[].linkedin_info.industry.id | integer | Yes | — | — |
result.data.search_results[].linkedin_info.industry.name | string | Yes | — | Maximum length: 255. |
result.data.search_results[].linkedin_info.public_profile_url | string | null | Yes | — | Get LinkedIn public profile URL. |
result.data.search_results[].addresses | array | Yes | — | — |
result.data.search_results[].addresses[].street_number | string | null | No | — | Maximum length: 255. |
result.data.search_results[].addresses[].street_name | string | null | No | — | Maximum length: 255. |
result.data.search_results[].addresses[].city | string | null | No | — | Maximum length: 255. |
result.data.search_results[].addresses[].state | string | null | No | — | Maximum length: 255. |
result.data.search_results[].addresses[].postcode | string | null | No | — | Maximum length: 64. |
result.data.search_results[].addresses[].country | string | Yes | — | Maximum length: 255. |
result.data.search_results[].addresses[].summary | string | Yes | — | — |
result.data.search_results[].date_updated | string | Yes | — | Format: date-time. |
result.data.search_results[].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. |
result.data.search_results[].found_simple_events[].id | integer | Yes | — | — |
result.data.search_results[].found_simple_events[].source | "product_hunt" | "form_c_sec_gov" | "form_d_sec_gov" | Yes | — | * 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. |
result.data.search_results[].found_simple_events[].date_featured | string | Yes | — | Format: date. |
result.data.search_results[].found_simple_events[].organization_id | integer | Yes | — | — |
result.data.search_results[].found_simple_events[].reason | "report_released" | "promoted_on_site" | Yes | — | * report_released - Report released * promoted_on_site - Promoted on site Allowed: report_released, promoted_on_site. |
result.data.search_results[].found_simple_events[].url | string | Yes | — | Format: uri. Maximum length: 255. |
result.data.search_results[].found_funding_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. |
result.data.search_results[].found_funding_events[].id | integer | Yes | — | — |
This output schema is too large to embed without slowing the page. Get the complete live contract with
deepline tools get forager_organization_search --json.Deepline cost
- Pricing model:
per_page(per page). - Estimated Deepline credits:
0.32per pricing unit.