---
agentTools:
  projectIndex: https://datagmaapi.readme.io/llms.txt
---

# Search Phone Numbers

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "external/datagma-proto/ingress.proto",
    "version": "3.11"
  },
  "servers": [
    {
      "url": "https://gateway.datagma.net"
    },
    {
      "url": "http://gateway.datagma.net"
    }
  ],
  "tags": [
    {
      "name": "Datagma"
    }
  ],
  "paths": {
    "/api/ingress/v1/search": {
      "get": {
        "tags": [
          "Datagma"
        ],
        "summary": "Search Phone Numbers",
        "operationId": "IngressService_Search",
        "parameters": [
          {
            "name": "apiId",
            "in": "query",
            "description": "Your API key. Can be found here https://app.datagma.com/user-api",
            "required": true,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "format": "password"
            }
          },
          {
            "name": "email",
            "in": "query",
            "description": "Email address. You can use the same time, Username & email address to improve the found rate.",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "username",
            "in": "query",
            "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.",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "minimumMatch",
            "in": "query",
            "description": "Minimum match. We suggest to let 1. You can lower the value if you want more results, but less accurate.",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "number",
              "default": 1,
              "format": "double"
            }
          },
          {
            "name": "whatsapp_check",
            "in": "query",
            "description": "We can verify if the mobile number is linked to aWhatsApp account",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ingressSearchResponse"
                }
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/rpcStatus"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "SearchName": {
        "type": "object",
        "properties": {
          "first": {
            "type": "string"
          },
          "middle": {
            "type": "string"
          },
          "last": {
            "type": "string"
          },
          "display": {
            "type": "string"
          }
        }
      },
      "SearchUserName": {
        "type": "object",
        "properties": {
          "content": {
            "type": "string"
          }
        }
      },
      "SearchEmail": {
        "type": "object",
        "properties": {
          "address": {
            "type": "string"
          },
          "address_md5": {
            "type": "string"
          }
        }
      },
      "SearchPhone": {
        "type": "object",
        "properties": {
          "country_code": {
            "type": "integer",
            "format": "int64"
          },
          "number": {
            "type": "integer",
            "format": "int64"
          },
          "display": {
            "type": "string"
          },
          "displayInternational": {
            "type": "string"
          }
        }
      },
      "SearchDOB": {
        "type": "object",
        "properties": {
          "date_range": {
            "$ref": "#/components/schemas/SearchDateRange"
          },
          "display": {
            "type": "string"
          }
        }
      },
      "SearchAddress": {
        "type": "object",
        "properties": {
          "country": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "display": {
            "type": "string"
          }
        }
      },
      "SearchDateRange": {
        "type": "object",
        "properties": {
          "start": {
            "type": "string"
          },
          "end": {
            "type": "string"
          }
        }
      },
      "SearchPremium": {
        "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"
          }
        }
      },
      "ingressSearchPerson": {
        "type": "object",
        "properties": {
          "match": {
            "type": "number",
            "format": "double"
          },
          "names": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PersonName"
            }
          },
          "phones": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PersonPhone"
            }
          },
          "languages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PersonLanguage"
            }
          },
          "addresses": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PersonAddress"
            }
          },
          "emails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PersonEmail"
            }
          },
          "origin_countries": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PersonOriginCountry"
            }
          },
          "jobs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PersonJob"
            }
          },
          "user_ids": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PersonUserId"
            }
          },
          "urls": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PersonUrl"
            }
          }
        }
      },
      "PersonName": {
        "type": "object",
        "properties": {
          "valid_since": {
            "type": "string"
          },
          "last_seen": {
            "type": "string"
          },
          "first": {
            "type": "string"
          },
          "last": {
            "type": "string"
          },
          "display": {
            "type": "string"
          }
        }
      },
      "PersonPhone": {
        "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"
          }
        }
      },
      "PersonLanguage": {
        "type": "object",
        "properties": {
          "region": {
            "type": "string"
          },
          "inferred": {
            "type": "boolean"
          },
          "language": {
            "type": "string"
          },
          "display": {
            "type": "string"
          }
        }
      },
      "PersonAddress": {
        "type": "object",
        "properties": {
          "valid_since": {
            "type": "string"
          },
          "last_seen": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "display": {
            "type": "string"
          }
        }
      },
      "PersonEmail": {
        "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"
          }
        }
      },
      "PersonOriginCountry": {
        "type": "object",
        "properties": {
          "country": {
            "type": "string"
          }
        }
      },
      "PersonJob": {
        "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": {
            "$ref": "#/components/schemas/SearchDateRange"
          }
        }
      },
      "PersonUserId": {
        "type": "object",
        "properties": {
          "valid_since": {
            "type": "string"
          },
          "content": {
            "type": "string"
          }
        }
      },
      "PersonUrl": {
        "type": "object",
        "properties": {
          "source_id": {
            "type": "string"
          },
          "domain": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        }
      },
      "ingressQuerySearch": {
        "type": "object",
        "properties": {
          "names": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SearchName"
            }
          },
          "usernames": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SearchUserName"
            }
          },
          "emails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SearchEmail"
            }
          },
          "phones": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SearchPhone"
            }
          },
          "dob": {
            "$ref": "#/components/schemas/SearchDOB"
          },
          "addresses": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SearchAddress"
            }
          }
        }
      },
      "ingressAvailableData": {
        "type": "object",
        "properties": {
          "premium": {
            "$ref": "#/components/schemas/SearchPremium"
          }
        }
      },
      "ingressSearchResponse": {
        "type": "object",
        "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": {
            "$ref": "#/components/schemas/ingressQuerySearch"
          },
          "availableData": {
            "$ref": "#/components/schemas/ingressAvailableData"
          },
          "person": {
            "$ref": "#/components/schemas/ingressSearchPerson"
          },
          "possible_persons": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ingressSearchPerson"
            }
          },
          "creditBurn": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "protobufAny": {
        "type": "object",
        "properties": {
          "@type": {
            "type": "string"
          }
        },
        "additionalProperties": {}
      },
      "rpcStatus": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/protobufAny"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 98,
      "1": 2,
      "2": 59,
      "3": 221,
      "4": 216,
      "5": 81,
      "6": 72,
      "7": 0,
      "8": 56,
      "9": 153,
      "10": 41,
      "11": 36
    }
  }
}
```