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

# Firmable: People Search

> Search for people by id, company id, position, seniority, and department. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Search for people by id, company id, position, seniority, and department.

> [!NOTE]
>
> Tool ID: `firmable_people_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(
  'firmable_people_search',
  {
    "companyId": "company_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute firmable_people_search --input '{
  "companyId": "company_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": [
    {
      "person_id": "person_123",
      "position": "example",
      "company_name": "Example Corp"
    }
  ]
}
```

Use `deepline describe firmable_people_search --json` for the latest machine-readable contract.

## Input reference

Search for people by id, company id, position, seniority, and department

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.selectedCountry` | `"AU" \| "NZ" \| "SG" \| "MY" \| "ID" \| "PH" \| "HK" \| "JP" \| "VN" \| "KR" \| "TH" \| "US" \| "CA"` | No | — | The country to search against. Supported values: AU, NZ, SG, MY, ID, PH, HK, JP, VN, KR, TH, US, CA. Defaults to AU when not provided. (example: AU) Allowed: `AU`, `NZ`, `SG`, `MY`, `ID`, `PH`, `HK`, `JP`, `VN`, `KR`, `TH`, `US`, `CA`. |
| `payload.companyId` | `string` | Yes | — | The unique identifier for a company in the Firmable system. (example: f000000117274) |
| `payload.position` | `string` | No | — | The position of the person. (example: Software Engineer) |
| `payload.seniority` | `string` | No | — | The seniority of the person. (example: Senior) |
| `payload.department` | `string` | No | — | The department of the person. (example: Engineering) |
| `payload.from` | `string` | No | — | The offset to start the search from. (example: 0) |
| `payload.size` | `string` | No | — | The size of the search results. (example: 10) |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Search for people by id, company id, position, seniority, and department",
    "properties": {
      "selectedCountry": {
        "type": "string",
        "description": "The country to search against. Supported values: AU, NZ, SG, MY, ID, PH, HK, JP, VN, KR, TH, US, CA. Defaults to AU when not provided. (example: AU)",
        "enum": [
          "AU",
          "NZ",
          "SG",
          "MY",
          "ID",
          "PH",
          "HK",
          "JP",
          "VN",
          "KR",
          "TH",
          "US",
          "CA"
        ]
      },
      "companyId": {
        "type": "string",
        "description": "The unique identifier for a company in the Firmable system. (example: f000000117274)"
      },
      "position": {
        "type": "string",
        "description": "The position of the person. (example: Software Engineer)"
      },
      "seniority": {
        "type": "string",
        "description": "The seniority of the person. (example: Senior)"
      },
      "department": {
        "type": "string",
        "description": "The department of the person. (example: Engineering)"
      },
      "from": {
        "type": "string",
        "description": "The offset to start the search from. (example: 0)"
      },
      "size": {
        "type": "string",
        "description": "The size of the search results. (example: 10)"
      }
    },
    "required": [
      "companyId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `array \| object` | Yes | — | Firmable people search results or the observed zero-match response. |
| `result.data.success` | `boolean` | Yes | — | — |
| `result.data.totalPeople` | `integer` | Yes | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "description": "Firmable people search results or the observed zero-match response.",
        "anyOf": [
          {
            "type": "array",
            "description": "Provider response payload.",
            "items": {
              "type": "object",
              "properties": {
                "person_id": {
                  "type": "string",
                  "description": "The Firmable ID of the person."
                },
                "position": {
                  "type": "string",
                  "description": "The position of the person."
                },
                "company_name": {
                  "type": "string",
                  "description": "The name of the company the person works for."
                },
                "linkedin": {
                  "type": "string",
                  "description": "LinkedIn profile handle."
                },
                "has_email": {
                  "type": "boolean",
                  "description": "Whether the person has an email address."
                },
                "has_personal_email": {
                  "type": "boolean",
                  "description": "Whether the person has a personal email address."
                },
                "has_phone": {
                  "type": "boolean",
                  "description": "Whether the person has a phone number."
                },
                "has_dnd_phone": {
                  "type": "boolean",
                  "description": "Whether the person number is a DND number."
                },
                "has_mobile": {
                  "type": "boolean",
                  "description": "Whether the person has a mobile number."
                }
              },
              "additionalProperties": false
            }
          },
          {
            "type": "object",
            "description": "Firmable zero-match people search response.",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "totalPeople": {
                "type": "integer",
                "minimum": 0
              }
            },
            "required": [
              "success",
              "totalPeople"
            ],
            "additionalProperties": false
          }
        ]
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `per_result` (per result).
* Estimated Deepline credits: `3.57` per pricing unit.

## Related documentation

* [Firmable provider guide](https://deepline.com/docs/providers/firmable/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.