> ## 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 Search Founders

> Search Dealroom founder profiles by keyword. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Search Dealroom founder profiles by keyword.

<Info>
  Tool ID: `dealroom_search_founders`
</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_search_founders',
  {
    "keyword": "software companies hiring engineers",
    "keyword_type": "default",
    "keyword_match_type": "fuzzy"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute dealroom_search_founders --input '{
  "keyword": "software companies hiring engineers",
  "keyword_type": "default",
  "keyword_match_type": "fuzzy"
}' --json
```

## Example response

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

```json theme={null}
{
  "data": {
    "total": 123,
    "items": [
      {
        "type": "example",
        "id": 123,
        "name": "Example"
      }
    ]
  }
}
```

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

## Input reference

Searching and filtering through founders/people. Response limited to 100 results and 10k offset. To export a larger number of founders, refer to the Founders bulk search endpoint. For a better locations filtering, please use the [Lookup Locations](https://docs.dealroom.co/docs/premium-api/operations/lookupLocations) endpoint to get the list of locations to filter by.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.keyword` | `string \| array` | No | — | The keyword used in the request to search by. This should be input as a string or array parameter. Arrays allowed only when `keyword_type=default_next`. |
| `payload.keyword_type` | `"default" \| "default_next" \| "name" \| "website_domain"` | No | `"default"` | The type of keyword you want to search by. Can be: \* default: search through name and website \* default\_next: search through name, aliases, website, tagline, about and params \* name: searches by name \* website\_domain: searches through the path (website) of the companies Allowed: `default`, `default_next`, `name`, `website_domain`. |
| `payload.keyword_match_type` | `"fuzzy" \| "exact" \| "all" \| "any"` | No | `"fuzzy"` | The type of matching type that the search should use. There are several available types: \* fuzzy: returns names that contain terms similar to the search term, measured by a Levenshtein edit distance. Read the [ElasticSearch guide](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html) for more details. Not available for `keyword_type=default_next`; \* exact: returns names that contain an exact term in a provided field. Read the \[ElasticSearch See the live schema for the complete constraint. |
| `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. |
| `payload.sort` | `"name" \| "companies_num" \| "create_date" \| "founded_companies_total_funding" \| "last_updated" \| "last_updated_utc" \| "created_utc"` | No | — | Allowed: `name`, `companies_num`, `create_date`, `founded_companies_total_funding`, `last_updated`, `last_updated_utc`, `created_utc`. |
| `payload.limit` | `integer` | No | `10` | Allows you to set the limit of items in the response. The default of the field is **10** and the maximum is **100** items per response |
| `payload.offset` | `integer` | No | `0` | Allows you to offset the first results to return by a specified number |

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

  ### Input JSON Schema

  ````json theme={null}
  {
    "type": "object",
    "description": "Searching and filtering through founders/people. Response limited to 100 results and 10k offset. To export a larger number of founders, refer to the Founders bulk search endpoint. For a better locations filtering, please use the [Lookup Locations](https://docs.dealroom.co/docs/premium-api/operations/lookupLocations) endpoint to get the list of locations to filter by.",
    "properties": {
      "keyword": {
        "description": "The keyword used in the request to search by. This should be input as a string or array parameter. Arrays allowed only when `keyword_type=default_next`.",
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        ]
      },
      "keyword_type": {
        "type": "string",
        "description": "The type of keyword you want to search by. Can be: * default: search through name and website * default_next: search through name, aliases, website, tagline, about and params * name: searches by name * website_domain: searches through the path (website) of the companies",
        "default": "default",
        "enum": [
          "default",
          "default_next",
          "name",
          "website_domain"
        ]
      },
      "keyword_match_type": {
        "type": "string",
        "description": "The type of matching type that the search should use. There are several available types: * fuzzy: returns names that contain terms similar to the search term, measured by a Levenshtein edit distance. Read the [ElasticSearch guide](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-fuzzy-query.html) for more details. Not available for `keyword_type=default_next`; * exact: returns names that contain an exact term in a provided field. Read the [ElasticSearch guide](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html) for more details. Not available for `keyword_type=default_next`; * all: returns names that contain all terms in the search term or terms when keyword is array. Available when `keyword_type=default_next` only; * any: returns names that contain any terms in the search term or terms when keyword is array. Available when `keyword_type=default_next` only;",
        "default": "fuzzy",
        "enum": [
          "fuzzy",
          "exact",
          "all",
          "any"
        ]
      },
      "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: ``` type,id,name,path,sub_types,url,images,backgrounds,gender,is_serial_founder,universities,deleted,tagline,website_url,twitter_url,facebook_url,linkedin_url,google_url,playmarket_app_id,appstore_app_id,hq_locations,founder_score,is_founder,is_strong_founder,is_super_founder,is_promising_founder,founded_companies_total_funding,founded_companies_total_funding_currency,last_updated,last_updated_utc,created_utc,companies,business_emails ```"
      },
      "sort": {
        "type": "string",
        "enum": [
          "name",
          "companies_num",
          "create_date",
          "founded_companies_total_funding",
          "last_updated",
          "last_updated_utc",
          "created_utc"
        ]
      },
      "limit": {
        "type": "integer",
        "description": "Allows you to set the limit of items in the response. The default of the field is **10** and the maximum is **100** items per response",
        "default": 10
      },
      "offset": {
        "type": "integer",
        "description": "Allows you to offset the first results to return by a specified number",
        "default": 0
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ````
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.total` | `integer` | No | — | Total number of items Format: `int32`. |
| `result.data.items` | `array` | No | — | — |
| `result.data.items[].type` | `string` | No | — | The type or category of the entity. |
| `result.data.items[].id` | `integer` | No | — | Unique Dealroom identifier for the entity profile |
| `result.data.items[].name` | `string` | No | — | Entity name |
| `result.data.items[].path` | `string \| null` | No | — | Url path at dealroom.co |
| `result.data.items[].sub_types` | `array` | No | — | Entity sub-types |
| `result.data.items[].url` | `string` | No | — | Url at dealroom.co |
| `result.data.items[].images` | `object` | No | — | — |
| `result.data.items[].images.32x32` | `string` | No | — | Image of size 32x32 px |
| `result.data.items[].images.74x74` | `string` | No | — | Image of size 74x74 px |
| `result.data.items[].images.100x100` | `string` | No | — | Image of size 100x100 px |
| `result.data.items[].backgrounds` | `array` | No | — | Backgrounds array |
| `result.data.items[].backgrounds[].id` | `integer` | No | — | Param ID |
| `result.data.items[].backgrounds[].name` | `string` | No | — | Param name |
| `result.data.items[].gender` | `"male" \| "female" \| "non-binary" \| "none of the options" \| "prefer not to say"` | No | — | Person's gender Allowed: `male`, `female`, `non-binary`, `none of the options`, `prefer not to say`. |
| `result.data.items[].is_serial_founder` | `boolean` | No | — | Boolean value indicating whether the person is a serial founder or not. |
| `result.data.items[].universities` | `object` | No | — | — |
| `result.data.items[].universities.items` | `array` | No | — | — |
| `result.data.items[].universities.items[].id` | `integer` | No | — | — |
| `result.data.items[].universities.items[].degree` | `object \| null` | No | — | Degree |
| `result.data.items[].universities.items[].degree.id` | `integer` | No | — | Param ID |
| `result.data.items[].universities.items[].degree.name` | `string` | No | — | Param name |
| `result.data.items[].universities.items[].degree.years` | `integer` | No | — | Education years |
| `result.data.items[].universities.items[].majors` | `array` | No | — | Majors |
| `result.data.items[].universities.items[].majors[].id` | `integer` | No | — | Param ID |
| `result.data.items[].universities.items[].majors[].name` | `string` | No | — | Param name |
| `result.data.items[].universities.items[].year_start` | `integer \| null` | No | — | Education start year |
| `result.data.items[].universities.items[].year_end` | `integer \| null` | No | — | Education end year |
| `result.data.items[].universities.items[].university` | `object` | No | — | — |
| `result.data.items[].universities.items[].university.type` | `string` | No | — | The type or category of the entity. |
| `result.data.items[].universities.items[].university.id` | `integer` | No | — | Unique Dealroom identifier for the entity profile |
| `result.data.items[].universities.items[].university.name` | `string` | No | — | Entity name |
| `result.data.items[].universities.items[].university.path` | `string \| null` | No | — | Url path at dealroom.co |
| `result.data.items[].universities.items[].university.sub_types` | `array` | No | — | Entity sub-types |
| `result.data.items[].universities.items[].university.url` | `string` | No | — | Url at dealroom.co |
| `result.data.items[].universities.items[].university.images` | `object` | No | — | — |
| `result.data.items[].universities.items[].university.images.32x32` | `string` | No | — | Image of size 32x32 px |
| `result.data.items[].universities.items[].university.images.74x74` | `string` | No | — | Image of size 74x74 px |
| `result.data.items[].universities.items[].university.images.100x100` | `string` | No | — | Image of size 100x100 px |
| `result.data.items[].universities.total` | `integer` | No | — | Total number of items Format: `int32`. |
| `result.data.items[].deleted` | `boolean` | No | — | If true, this entity was already removed from Dealroom DB (deletion not yet fully propagated) |
| `result.data.items[].tagline` | `string \| null` | No | — | Short description of the entity |
| `result.data.items[].website_url` | `string \| null` | No | — | Website of the entity |
| `result.data.items[].twitter_url` | `string \| null` | No | — | URL of the entity's Twitter profile |
| `result.data.items[].facebook_url` | `string \| null` | No | — | URL of the entity's Facebook profile |
| `result.data.items[].linkedin_url` | `string \| null` | No | — | URL of the entity's LinkedIn profile |
| `result.data.items[].google_url` | `string \| null` | No | — | URL of the entity's Google plus profile |
| `result.data.items[].playmarket_app_id` | `string \| null` | No | — | The ID of the entity's mobile app in the Apple App Store |

The table shows the first 50 fields. Expand the raw schema 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_search_founders --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.