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

# Get lead by phone number

Busca um lead pelo número de telefone

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "API DO CHAT",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://sparks.chatpro.com.br"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/leads/findByPhoneNumber": {
      "post": {
        "summary": "Get lead by phone number",
        "description": "Busca um lead pelo número de telefone",
        "operationId": "leads-findbyphonenumber",
        "parameters": [
          {
            "name": "instance-token",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "instanceId"
                ],
                "properties": {
                  "instanceId": {
                    "type": "string",
                    "description": "Código da instância"
                  },
                  "phoneNumber": {
                    "type": "string",
                    "description": "Número de telefone do lead"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 101,
      "1": 249,
      "2": 161,
      "3": 244,
      "4": 175,
      "5": 140,
      "6": 208,
      "7": 0,
      "8": 37,
      "9": 0,
      "10": 82,
      "11": 217
    }
  }
}
```