> ## 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 Founder Filters

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

List supported Dealroom founder search filters.

<Info>
  Tool ID: `dealroom_get_founder_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_founder_filters',
  {
    "form_data": {
      "must": {},
      "should": {},
      "must_not": {}
    },
    "fields": "example"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute dealroom_get_founder_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": {
    "locations": {
      "key": "example",
      "items": [
        {
          "name": "Example",
          "count": 123,
          "active": true
        }
      ]
    },
    "companies_industries": {
      "key": "example",
      "items": [
        {
          "name": "Example",
          "count": 123,
          "active": true
        }
      ]
    },
    "universities": {
      "key": "example",
      "items": [
        {
          "name": "Example",
          "count": 123,
          "active": true
        }
      ]
    }
  }
}
```

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

## Input reference

Allows you to retrieve all the available filters on the founders endpoint. These can then be used in the founders search and founders bulk search, within the form\_data.

| 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 `founders/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": "Allows you to retrieve all the available filters on the founders endpoint. These can then be used in the founders search and founders bulk search, within the form_data.",
    "properties": {
      "form_data": {
        "type": "object",
        "description": "Allows you to apply filters to your search. All the filters available can be found in the `founders/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: ``` locations,companies_industries,universities,majors,degrees,age,gender,editorial,last_updated,last_updated_utc,created_utc_min,created_utc_max,is_promising_founder,is_strong_founder,backgrounds,companies_business_model,companies_client_focus,companies_income_streams,companies_num_unformatted,companies_sub_industries,companies_technologies,founded_companies_locations,founded_companies_total_funding_max,founded_companies_total_funding_min,founder_position_start_year_max,founder_position_start_year_min,founder_strength,labels,last_company_launch_startup_ranking_rating_max,last_company_launch_startup_ranking_rating_min,last_company_launch_year_max,last_company_launch_year_min,last_position_end_year_max,last_position_end_year_min,last_position_start_year_max,last_position_start_year_min,user_type,worked_at_unicorn,is_super_founder ```"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ````
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.locations` | `object` | No | — | — |
| `result.data.locations.key` | `string` | No | — | — |
| `result.data.locations.items` | `array \| null` | No | — | — |
| `result.data.locations.items[].name` | `string` | No | — | — |
| `result.data.locations.items[].count` | `integer` | No | — | — |
| `result.data.locations.items[].active` | `boolean` | No | — | — |
| `result.data.companies_industries` | `object` | No | — | — |
| `result.data.companies_industries.key` | `string` | No | — | — |
| `result.data.companies_industries.items` | `array \| null` | No | — | — |
| `result.data.companies_industries.items[].name` | `string` | No | — | — |
| `result.data.companies_industries.items[].count` | `integer` | No | — | — |
| `result.data.companies_industries.items[].active` | `boolean` | No | — | — |
| `result.data.universities` | `object` | No | — | — |
| `result.data.universities.key` | `string` | No | — | — |
| `result.data.universities.items` | `array \| null` | No | — | — |
| `result.data.universities.items[].name` | `string` | No | — | — |
| `result.data.universities.items[].count` | `integer` | No | — | — |
| `result.data.universities.items[].active` | `boolean` | No | — | — |
| `result.data.majors` | `object` | No | — | — |
| `result.data.majors.key` | `string` | No | — | — |
| `result.data.majors.items` | `array \| null` | No | — | — |
| `result.data.majors.items[].name` | `string` | No | — | — |
| `result.data.majors.items[].count` | `integer` | No | — | — |
| `result.data.majors.items[].active` | `boolean` | No | — | — |
| `result.data.degrees` | `object` | No | — | — |
| `result.data.degrees.key` | `string` | No | — | — |
| `result.data.degrees.items` | `array \| null` | No | — | — |
| `result.data.degrees.items[].name` | `string` | No | — | — |
| `result.data.degrees.items[].count` | `integer` | No | — | — |
| `result.data.degrees.items[].active` | `boolean` | No | — | — |
| `result.data.age` | `object` | No | — | — |
| `result.data.age.key` | `string` | No | — | — |
| `result.data.age.items` | `array \| null` | No | — | — |
| `result.data.age.items[].name` | `string` | No | — | — |
| `result.data.age.items[].count` | `integer` | No | — | — |
| `result.data.age.items[].active` | `boolean` | No | — | — |
| `result.data.gender` | `object` | No | — | — |
| `result.data.gender.key` | `string` | No | — | — |
| `result.data.gender.items` | `array \| null` | No | — | — |
| `result.data.gender.items[].name` | `string` | No | — | — |
| `result.data.gender.items[].count` | `integer` | No | — | — |
| `result.data.gender.items[].active` | `boolean` | No | — | — |
| `result.data.editorial` | `object` | No | — | — |
| `result.data.editorial.key` | `string` | No | — | — |
| `result.data.editorial.items` | `array \| null` | No | — | — |
| `result.data.editorial.items[].name` | `string` | No | — | — |
| `result.data.editorial.items[].count` | `integer` | No | — | — |
| `result.data.editorial.items[].active` | `boolean` | No | — | — |
| `result.data.last_updated` | `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. |

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