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

# GetLeads: Batch Phone Lookup

> Look up several GetLeads contacts from phone numbers in one request. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Look up several GetLeads contacts from phone numbers in one request.

> [!NOTE]
>
> Tool ID: `getleads_batch_phone_lookup`

## 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(
  'getleads_batch_phone_lookup',
  {
    "items": [
      {
        "phone": "+14155550123",
        "cellphone": "+14155550123"
      }
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute getleads_batch_phone_lookup --input '{
  "items": [
    {
      "phone": "+14155550123",
      "cellphone": "+14155550123"
    }
  ]
}' --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": {
    "ok": true,
    "results": [
      {
        "phone": "+14155550123",
        "cellphone": "+14155550123",
        "success": true
      }
    ],
    "message": "Example message"
  }
}
```

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

## Input reference

Look up contacts by phone numbers.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.items` | `array` | Yes | — | — |
| `payload.limit_per_item` | `integer` | No | `1` | Maximum: 10. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Look up contacts by phone numbers.",
    "properties": {
      "items": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "phone": {
              "type": "string"
            },
            "cellphone": {
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      },
      "limit_per_item": {
        "type": "integer",
        "default": 1,
        "maximum": 10
      }
    },
    "required": [
      "items"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.ok` | `boolean` | No | — | — |
| `result.data.results` | `array` | No | — | — |
| `result.data.results[].phone` | `string` | No | — | — |
| `result.data.results[].cellphone` | `string` | No | — | — |
| `result.data.results[].success` | `boolean` | No | — | — |
| `result.data.results[].data` | `record` | No | — | Contact record. Fields vary based on dataset and column selection. |
| `result.data.results[].skipped_reason` | `string` | No | — | — |
| `result.data.message` | `string` | No | — | — |
| `result.data.code` | `string` | No | — | — |
| `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": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "ok": {
            "type": "boolean"
          },
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "phone": {
                  "type": "string"
                },
                "cellphone": {
                  "type": "string"
                },
                "success": {
                  "type": "boolean"
                },
                "data": {
                  "type": "object",
                  "description": "Contact record. Fields vary based on dataset and column selection.",
                  "additionalProperties": true
                },
                "skipped_reason": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "message": {
            "type": "string"
          },
          "code": {
            "type": "string"
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `1.75` per pricing unit.

## Related documentation

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