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

# Datagma: Search Phone Numbers

> Find a person's mobile or direct phone number from an email address or a LinkedIn profile username. Includes SDK V2 examples, schemas, and cost.

Find a person's mobile or direct phone number from an email address or a LinkedIn profile username.

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

## 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(
  'datagma_search_phone_numbers',
  {
    "email": "jane.doe@example.com",
    "username": "user@example.com",
    "minimumMatch": 1
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute datagma_search_phone_numbers --input '{
  "email": "jane.doe@example.com",
  "username": "user@example.com",
  "minimumMatch": 1
}' --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": {
    "httpStatusCode": 123,
    "visibleSources": 123,
    "availableSources": 123
  }
}
```

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

## Input reference

Search Phone Numbers

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.email` | `string` | No | — | Email address. You can use the same time, Username & email address to improve the found rate. |
| `payload.username` | `string` | No | — | Can be a Social Media Url. You can't use Sales Navigator URL. You can use the same time, Username & email address to improve the found rate. If you do not have the social URL or the email, please use the Full Enrich endpoint. |
| `payload.minimumMatch` | `number` | No | `1` | Minimum match. We suggest to let 1. You can lower the value if you want more results, but less accurate. Format: `double`. |
| `payload.whatsapp_check` | `boolean` | No | — | We can verify if the mobile number is linked to aWhatsApp account |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Search Phone Numbers",
    "properties": {
      "email": {
        "type": "string",
        "description": "Email address. You can use the same time, Username & email address to improve the found rate."
      },
      "username": {
        "type": "string",
        "description": "Can be a Social Media Url. You can't use Sales Navigator URL. You can use the same time, Username & email address to improve the found rate. If you do not have the social URL or the email, please use the Full Enrich endpoint."
      },
      "minimumMatch": {
        "type": "number",
        "description": "Minimum match. We suggest to let 1. You can lower the value if you want more results, but less accurate.",
        "default": 1,
        "format": "double"
      },
      "whatsapp_check": {
        "type": "boolean",
        "description": "We can verify if the mobile number is linked to aWhatsApp account"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.httpStatusCode` | `integer` | No | — | Format: `int64`. |
| `result.data.visibleSources` | `integer` | No | — | Format: `int64`. |
| `result.data.availableSources` | `integer` | No | — | Format: `int64`. |
| `result.data.personsCount` | `integer` | No | — | Format: `int64`. |
| `result.data.warnings` | `array` | No | — | — |
| `result.data.query` | `object` | No | — | — |
| `result.data.query.names` | `array` | No | — | — |
| `result.data.query.names[].first` | `string` | No | — | — |
| `result.data.query.names[].middle` | `string` | No | — | — |
| `result.data.query.names[].last` | `string` | No | — | — |
| `result.data.query.names[].display` | `string` | No | — | — |
| `result.data.query.usernames` | `array` | No | — | — |
| `result.data.query.usernames[].content` | `string` | No | — | — |
| `result.data.query.emails` | `array` | No | — | — |
| `result.data.query.emails[].address` | `string` | No | — | — |
| `result.data.query.emails[].address_md5` | `string` | No | — | — |
| `result.data.query.phones` | `array` | No | — | — |
| `result.data.query.phones[].country_code` | `integer` | No | — | Format: `int64`. |
| `result.data.query.phones[].number` | `integer` | No | — | Format: `int64`. |
| `result.data.query.phones[].display` | `string` | No | — | — |
| `result.data.query.phones[].displayInternational` | `string` | No | — | — |
| `result.data.query.dob` | `object` | No | — | — |
| `result.data.query.dob.date_range` | `object` | No | — | — |
| `result.data.query.dob.date_range.start` | `string` | No | — | — |
| `result.data.query.dob.date_range.end` | `string` | No | — | — |
| `result.data.query.dob.display` | `string` | No | — | — |
| `result.data.query.addresses` | `array` | No | — | — |
| `result.data.query.addresses[].country` | `string` | No | — | — |
| `result.data.query.addresses[].state` | `string` | No | — | — |
| `result.data.query.addresses[].display` | `string` | No | — | — |
| `result.data.availableData` | `object` | No | — | — |
| `result.data.availableData.premium` | `object` | No | — | — |
| `result.data.availableData.premium.relationships` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.usernames` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.jobs` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.addresses` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.ethnicities` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.phones` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.mobile_phones` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.landline_phones` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.educations` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.languages` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.user_ids` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.social_profiles` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.names` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.dobs` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.images` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.genders` | `integer` | No | — | Format: `int64`. |
| `result.data.availableData.premium.emails` | `integer` | No | — | Format: `int64`. |

The table shows the first 50 fields. Expand the raw schema below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe datagma_search_phone_numbers --json`.

## Deepline cost

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

## Related documentation

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