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

# Dealroom.co: Dealroom Get Company Filters

> List supported Dealroom company search filters. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List supported Dealroom company search filters.

<Info>
  Tool ID: `dealroom_get_company_filters`
</Info>

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

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'dealroom_get_company_filters',
  {
    "form_data": {
      "must": {},
      "should": {},
      "must_not": {}
    },
    "fields": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute dealroom_get_company_filters --input '{
  "form_data": {
    "must": {},
    "should": {},
    "must_not": {}
  },
  "fields": "example"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "all_regions": {
      "key": "example",
      "items": [
        {
          "name": "Example",
          "count": 123,
          "active": true
        }
      ]
    },
    "client_focus": {
      "key": "example",
      "items": [
        {
          "name": "Example",
          "count": 123,
          "active": true
        }
      ]
    },
    "company_status": {
      "key": "example",
      "items": [
        {
          "name": "Example",
          "count": 123,
          "active": true
        }
      ]
    }
  }
}
```

Use `deepline tools get dealroom_get_company_filters --json` for the latest machine-readable contract.

## Input reference

To retrieve all available filters in the API, by which you can search for companies, you can use the Companies filters. This endpoint provides all the different filters and the items available for them. For example, it gives(provides is best word choice) the available locations to search by, funding round ranges to search by and similar. Using the form\_data on this endpoint also allows you to see which specific filters exist for e.g. a specific location or a specific industry. The endpoint can be reached using the POST request method. Requesting this endpoint without any specifications will return all available filters. To enter additional parameters, check the details below. All location values are available [here](https://docs.google.com/spreadsheets/d/1ijNao074EB7DSXwqQBehl4TWcpLbrklhP0unp8PDwO8).

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.form_data` | `object` | No | — | Allows you to apply filters to your search. All the filters available can be found in the `companies/filters` endpoint. For quick reference, use a POST method on the following URL: The field can take in several different conditions: \* must: The clause (query) must appear in matching documents and will contribute to the score. \* should: The clause (query) should appear in the matching document. \* must\_not: The clause (query) must not appear in the matching documents |
| `payload.fields` | `string` | No | — | Allows you to select which fields the response should return. All available fields are specified below(by data type) and in the response sample to the right. The fields should be input as a comma-separated string . Nested fields are supported using the brackets notation. \* Default Fields: `All fields are available by default` \* All Fields: \`\`\` See the live schema for the complete constraint. |

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

  ### Input JSON Schema

  ````json theme={null}
  {
    "type": "object",
    "description": "To retrieve all available filters in the API, by which you can search for companies, you can use the Companies filters. This endpoint provides all the different filters and the items available for them. For example, it gives(provides is best word choice) the available locations to search by, funding round ranges to search by and similar. Using the form_data on this endpoint also allows you to see which specific filters exist for e.g. a specific location or a specific industry. The endpoint can be reached using the POST request method. Requesting this endpoint without any specifications will return all available filters. To enter additional parameters, check the details below. All location values are available [here](https://docs.google.com/spreadsheets/d/1ijNao074EB7DSXwqQBehl4TWcpLbrklhP0unp8PDwO8).",
    "properties": {
      "form_data": {
        "type": "object",
        "description": "Allows you to apply filters to your search. All the filters available can be found in the `companies/filters` endpoint. For quick reference, use a POST method on the following URL: The field can take in several different conditions: * must: The clause (query) must appear in matching documents and will contribute to the score. * should: The clause (query) should appear in the matching document. * must_not: The clause (query) must not appear in the matching documents",
        "properties": {
          "must": {
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "date"
                },
                {
                  "type": "integer"
                },
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              ]
            }
          },
          "should": {
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "date"
                },
                {
                  "type": "integer"
                },
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              ]
            }
          },
          "must_not": {
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "date"
                },
                {
                  "type": "integer"
                },
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              ]
            }
          }
        },
        "additionalProperties": false
      },
      "fields": {
        "type": "string",
        "description": "Allows you to select which fields the response should return. All available fields are specified below(by data type) and in the response sample to the right. The fields should be input as a comma-separated string . Nested fields are supported using the brackets notation. * Default Fields: ``` All fields are available by default ``` * All Fields: ``` all_regions,client_focus,company_status,created_utc_max,created_utc_min,data_type,labels,dealroom_signal_max,dealroom_signal_min,delivery_methods,employees,employees_max,employees_min,founders_strength,founders_backgrounds,founders_degrees,founders_gender,founders_is_serial_founder,founders_universities,founding_or_hq_regions,founding_regions,funded,fundings,growth_stages,has_founder,has_patents,has_promising_founder,has_strong_founder,has_super_founder,has_website_url,hq_regions,income_streams,industries,last_round_amount_max,last_round_amount_min,last_round_date_max,last_round_date_min,last_round_month,last_round_type,last_round_year,last_updated,last_updated_utc,launch_year,launch_year_max,launch_year_min,non_hq_regions,ownerships,patents_categories,patents_sub_categories,raised_rounds,revenue_max,revenue_min,revenues,sdgs,seed_year,seed_year_max,seed_year_min,startup_ranking_max,startup_ranking_min,sub_industries,tags,technologies,total_funding_max,total_funding_min,valuation_at_ipo_max,valuation_at_ipo_min,valuation_max,valuation_min,vc_backed,year_became_future_unicorn_max,year_became_future_unicorn_min,year_became_unicorn_max,year_became_unicorn_min,is_fundraising,is_hiring,non_hq_locations,hq_locations,founding_locations,founding_or_hq_locations,all_locations,company_type ```"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ````
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.all_regions` | `object` | No | — | — |
| `result.data.all_regions.key` | `string` | No | — | — |
| `result.data.all_regions.items` | `array \| null` | No | — | — |
| `result.data.all_regions.items[].name` | `string` | No | — | — |
| `result.data.all_regions.items[].count` | `integer` | No | — | — |
| `result.data.all_regions.items[].active` | `boolean` | No | — | — |
| `result.data.client_focus` | `object` | No | — | — |
| `result.data.client_focus.key` | `string` | No | — | — |
| `result.data.client_focus.items` | `array \| null` | No | — | — |
| `result.data.client_focus.items[].name` | `string` | No | — | — |
| `result.data.client_focus.items[].count` | `integer` | No | — | — |
| `result.data.client_focus.items[].active` | `boolean` | No | — | — |
| `result.data.company_status` | `object` | No | — | — |
| `result.data.company_status.key` | `string` | No | — | — |
| `result.data.company_status.items` | `array \| null` | No | — | — |
| `result.data.company_status.items[].name` | `string` | No | — | — |
| `result.data.company_status.items[].count` | `integer` | No | — | — |
| `result.data.company_status.items[].active` | `boolean` | No | — | — |
| `result.data.created_utc_max` | `object` | No | — | Range filter. For convertable amount filters (e.g. total\_funding\_min, total\_funding\_max, last\_funding\_amount\_min), the filter object in the request may include an optional `currency` (ISO 4217) to specify the source currency of the amount. |
| `result.data.created_utc_max.key` | `string` | No | — | — |
| `result.data.created_utc_max.value` | `integer \| string \| null` | No | — | — |
| `result.data.created_utc_min` | `object` | No | — | Range filter. For convertable amount filters (e.g. total\_funding\_min, total\_funding\_max, last\_funding\_amount\_min), the filter object in the request may include an optional `currency` (ISO 4217) to specify the source currency of the amount. |
| `result.data.created_utc_min.key` | `string` | No | — | — |
| `result.data.created_utc_min.value` | `integer \| string \| null` | No | — | — |
| `result.data.data_type` | `object` | No | — | — |
| `result.data.data_type.key` | `string` | No | — | — |
| `result.data.data_type.items` | `array \| null` | No | — | — |
| `result.data.data_type.items[].name` | `string` | No | — | — |
| `result.data.data_type.items[].count` | `integer` | No | — | — |
| `result.data.data_type.items[].active` | `boolean` | No | — | — |
| `result.data.labels` | `object` | No | — | — |
| `result.data.labels.key` | `string` | No | — | — |
| `result.data.labels.items` | `array \| null` | No | — | — |
| `result.data.labels.items[].name` | `string` | No | — | — |
| `result.data.labels.items[].count` | `integer` | No | — | — |
| `result.data.labels.items[].active` | `boolean` | No | — | — |
| `result.data.dealroom_signal_max` | `object` | No | — | Range filter. For convertable amount filters (e.g. total\_funding\_min, total\_funding\_max, last\_funding\_amount\_min), the filter object in the request may include an optional `currency` (ISO 4217) to specify the source currency of the amount. |
| `result.data.dealroom_signal_max.key` | `string` | No | — | — |
| `result.data.dealroom_signal_max.value` | `integer \| string \| null` | No | — | — |
| `result.data.dealroom_signal_min` | `object` | No | — | Range filter. For convertable amount filters (e.g. total\_funding\_min, total\_funding\_max, last\_funding\_amount\_min), the filter object in the request may include an optional `currency` (ISO 4217) to specify the source currency of the amount. |
| `result.data.dealroom_signal_min.key` | `string` | No | — | — |
| `result.data.dealroom_signal_min.value` | `integer \| string \| null` | No | — | — |
| `result.data.delivery_methods` | `object` | No | — | — |
| `result.data.delivery_methods.key` | `string` | No | — | — |
| `result.data.delivery_methods.items` | `array \| null` | No | — | — |
| `result.data.delivery_methods.items[].name` | `string` | No | — | — |
| `result.data.delivery_methods.items[].count` | `integer` | No | — | — |
| `result.data.delivery_methods.items[].active` | `boolean` | No | — | — |
| `result.data.employees` | `object` | No | — | — |

The table shows the first 50 fields. Use the live contract below for every field.

<Info>
  This output schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get dealroom_get_company_filters --json`.
</Info>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Dealroom.co provider guide](/docs/providers/dealroom/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


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