> ## 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: Inputs, Cost & CLI Example

> Search for people by id, company id, position, seniority, and department. Includes inputs, outputs, costs, and Deepline CLI examples for GTM automation.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=firmable_people_search:{"companyId":"{{companyId}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                      | Type                                                                                                   | Required | Default | Description                                                                                                                                          |
| ------------------------- | ------------------------------------------------------------------------------------------------------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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) |
| `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)                                                                                                        |

### Allowed values

| Field                     | Allowed values                                                               |
| ------------------------- | ---------------------------------------------------------------------------- |
| `payload.selectedCountry` | `AU`, `NZ`, `SG`, `MY`, `ID`, `PH`, `HK`, `JP`, `VN`, `KR`, `TH`, `US`, `CA` |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "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 Schema

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

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute firmable_people_search --payload '{
  "companyId": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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