> ## 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: Organization Search

> Search companies by industry, keywords, location, headcount, founding date, revenue and domain. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Search companies by industry, keywords, location, headcount, founding date, revenue and domain.

> [!NOTE]
>
> Tool ID: `forager_organization_search`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute forager_organization_search --input '{
  "page": 123,
  "organization_ids": [
    123
  ],
  "description": "Example description"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe 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`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Organization search request serializer.",
    "properties": {
      "page": {
        "type": "integer"
      },
      "organization_ids": {
        "type": "array",
        "description": "To get a list of IDs use Organizations lookup endpoint .",
        "items": {
          "type": "integer"
        }
      },
      "description": {
        "type": "string"
      },
      "locations": {
        "type": "array",
        "description": "To get a list of IDs use Locations lookup endpoint .",
        "items": {
          "type": "integer"
        }
      },
      "industries": {
        "type": "array",
        "description": "To get a list of IDs use Industries lookup endpoint .",
        "items": {
          "type": "integer"
        }
      },
      "industries_exclude": {
        "type": "array",
        "description": "To get a list of IDs use Industries lookup endpoint .",
        "items": {
          "type": "integer"
        }
      },
      "keywords": {
        "type": "array",
        "description": "To get a list of IDs use Organization keywords lookup endpoint .",
        "items": {
          "type": "integer"
        }
      },
      "employees_start": {
        "type": "integer"
      },
      "employees_end": {
        "type": "integer"
      },
      "founded_date_start": {
        "type": "string",
        "format": "date"
      },
      "founded_date_end": {
        "type": "string",
        "format": "date"
      },
      "revenue_start": {
        "type": "integer"
      },
      "revenue_end": {
        "type": "integer"
      },
      "domains": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "domain_rank_start": {
        "type": "integer"
      },
      "domain_rank_end": {
        "type": "integer"
      },
      "domain_traffic_start": {
        "type": "integer"
      },
      "domain_traffic_end": {
        "type": "integer"
      },
      "web_technologies": {
        "type": "array",
        "description": "To get a list of IDs use Organization keywords lookup endpoint .",
        "items": {
          "type": "integer"
        }
      },
      "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
  }
  ```
</details>

## 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 | — | — |

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

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe forager_organization_search --json`.

## Deepline cost

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

## Related documentation

* [Forager provider guide](https://deepline.com/docs/providers/forager/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.