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

> Search direct mobile numbers from an email address or social profile. 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=datagma_search_phone_numbers:{}' --json
```

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

## Input Schema

| Name                     | Type      | Required | Default | Description                                                                                                                                                                                                                       |
| ------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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.                                                                                                                          |
| `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={null}
  {
    "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 Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `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": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "httpStatusCode": {
            "type": "integer",
            "format": "int64"
          },
          "visibleSources": {
            "type": "integer",
            "format": "int64"
          },
          "availableSources": {
            "type": "integer",
            "format": "int64"
          },
          "personsCount": {
            "type": "integer",
            "format": "int64"
          },
          "warnings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "query": {
            "type": "object",
            "properties": {
              "names": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "first": {
                      "type": "string"
                    },
                    "middle": {
                      "type": "string"
                    },
                    "last": {
                      "type": "string"
                    },
                    "display": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "usernames": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "content": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "emails": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "address": {
                      "type": "string"
                    },
                    "address_md5": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "phones": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "country_code": {
                      "type": "integer",
                      "format": "int64"
                    },
                    "number": {
                      "type": "integer",
                      "format": "int64"
                    },
                    "display": {
                      "type": "string"
                    },
                    "displayInternational": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "dob": {
                "type": "object",
                "properties": {
                  "date_range": {
                    "type": "object",
                    "properties": {
                      "start": {
                        "type": "string"
                      },
                      "end": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  },
                  "display": {
                    "type": "string"
                  }
                },
                "additionalProperties": false
              },
              "addresses": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "country": {
                      "type": "string"
                    },
                    "state": {
                      "type": "string"
                    },
                    "display": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          },
          "availableData": {
            "type": "object",
            "properties": {
              "premium": {
                "type": "object",
                "properties": {
                  "relationships": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "usernames": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "jobs": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "addresses": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "ethnicities": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "phones": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "mobile_phones": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "landline_phones": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "educations": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "languages": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "user_ids": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "social_profiles": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "names": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "dobs": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "images": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "genders": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "emails": {
                    "type": "integer",
                    "format": "int64"
                  },
                  "origin_countries": {
                    "type": "integer",
                    "format": "int64"
                  }
                },
                "additionalProperties": false
              }
            },
            "additionalProperties": false
          },
          "person": {
            "type": "object",
            "properties": {
              "match": {
                "type": "number",
                "format": "double"
              },
              "names": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "valid_since": {
                      "type": "string"
                    },
                    "last_seen": {
                      "type": "string"
                    },
                    "first": {
                      "type": "string"
                    },
                    "last": {
                      "type": "string"
                    },
                    "display": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "phones": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "valid_since": {
                      "type": "string"
                    },
                    "last_seen": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    },
                    "country_code": {
                      "type": "integer",
                      "format": "int64"
                    },
                    "number": {
                      "type": "integer",
                      "format": "int64"
                    },
                    "display": {
                      "type": "string"
                    },
                    "display_international": {
                      "type": "string"
                    },
                    "linkedWhatsapp": {
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "languages": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "region": {
                      "type": "string"
                    },
                    "inferred": {
                      "type": "boolean"
                    },
                    "language": {
                      "type": "string"
                    },
                    "display": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "addresses": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "valid_since": {
                      "type": "string"
                    },
                    "last_seen": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    },
                    "country": {
                      "type": "string"
                    },
                    "city": {
                      "type": "string"
                    },
                    "display": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "emails": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "valid_since": {
                      "type": "string"
                    },
                    "last_seen": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    },
                    "email_provider": {
                      "type": "boolean"
                    },
                    "address": {
                      "type": "string"
                    },
                    "address_md5": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "origin_countries": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "country": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "jobs": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "valid_since": {
                      "type": "string"
                    },
                    "last_seen": {
                      "type": "string"
                    },
                    "title": {
                      "type": "string"
                    },
                    "organization": {
                      "type": "string"
                    },
                    "industry": {
                      "type": "string"
                    },
                    "display": {
                      "type": "string"
                    },
                    "date_range": {
                      "type": "object",
                      "properties": {
                        "start": {
                          "type": "string"
                        },
                        "end": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": false
                    }
                  },
                  "additionalProperties": false
                }
              },
              "user_ids": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "valid_since": {
                      "type": "string"
                    },
                    "content": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "urls": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "source_id": {
                      "type": "string"
                    },
                    "domain": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "category": {
                      "type": "string"
                    },
                    "url": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          },
          "possible_persons": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "match": {
                  "type": "number",
                  "format": "double"
                },
                "names": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "valid_since": {
                        "type": "string"
                      },
                      "last_seen": {
                        "type": "string"
                      },
                      "first": {
                        "type": "string"
                      },
                      "last": {
                        "type": "string"
                      },
                      "display": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "phones": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "valid_since": {
                        "type": "string"
                      },
                      "last_seen": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string"
                      },
                      "country_code": {
                        "type": "integer",
                        "format": "int64"
                      },
                      "number": {
                        "type": "integer",
                        "format": "int64"
                      },
                      "display": {
                        "type": "string"
                      },
                      "display_international": {
                        "type": "string"
                      },
                      "linkedWhatsapp": {
                        "type": "boolean"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "languages": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "region": {
                        "type": "string"
                      },
                      "inferred": {
                        "type": "boolean"
                      },
                      "language": {
                        "type": "string"
                      },
                      "display": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "addresses": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "valid_since": {
                        "type": "string"
                      },
                      "last_seen": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string"
                      },
                      "country": {
                        "type": "string"
                      },
                      "city": {
                        "type": "string"
                      },
                      "display": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "emails": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "valid_since": {
                        "type": "string"
                      },
                      "last_seen": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string"
                      },
                      "email_provider": {
                        "type": "boolean"
                      },
                      "address": {
                        "type": "string"
                      },
                      "address_md5": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "origin_countries": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "country": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "jobs": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "valid_since": {
                        "type": "string"
                      },
                      "last_seen": {
                        "type": "string"
                      },
                      "title": {
                        "type": "string"
                      },
                      "organization": {
                        "type": "string"
                      },
                      "industry": {
                        "type": "string"
                      },
                      "display": {
                        "type": "string"
                      },
                      "date_range": {
                        "type": "object",
                        "properties": {
                          "start": {
                            "type": "string"
                          },
                          "end": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "user_ids": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "valid_since": {
                        "type": "string"
                      },
                      "content": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "urls": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "source_id": {
                        "type": "string"
                      },
                      "domain": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      },
                      "category": {
                        "type": "string"
                      },
                      "url": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                }
              },
              "additionalProperties": false
            }
          }
        },
        "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 datagma_search_phone_numbers --payload '{}' --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: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.14` per pricing unit.
* Billing mode: `post_deduct`.
