Look up lead by phone

GET

leads

lookup

cURL

curl --request GET \
  --url https://api.attent.app/v1/leads/lookup \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.attent.app/v1/leads/lookup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.attent.app/v1/leads/lookup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.attent.app/v1/leads/lookup"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.attent.app/v1/leads/lookup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "1234"
}

{
  "message": "Invalid phone number format."
}

{
  "message": "Forbidden"
}

{
  "message": "Lead not found."
}

{
  "message": "Multiple leads match this phone number; provide outboundPhone."
}

{
  "message": "Internal Server Error"
}

Usage Notes

Use phone to look up a lead by their phone number. If exactly one active lead matches that phone number, the response returns the lead ID. When the same lead phone number is associated with multiple outbound phone numbers, include outboundPhone to identify which lead to return. The outbound phone number must be one of the phone numbers configured for your organization.

Authorizations

x-api-key

string

header

required

Query Parameters

phone

string

required

The phone number of the lead to look up The phone number must begin with an area code (+) and can contain digits, spaces, parentheses, and hyphens (e.g. +1 (555) 555-5555)

outboundPhone

string

The configured outbound phone number associated with the lead. The phone number must begin with an area code (+) and can contain digits, spaces, parentheses, and hyphens (e.g. +1 (555) 555-5555)

Response

Lead found successfully.

string

required

The ID of the lead associated with the provided phone number.

cURL

curl --request GET \
  --url https://api.attent.app/v1/leads/lookup \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.attent.app/v1/leads/lookup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.attent.app/v1/leads/lookup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.attent.app/v1/leads/lookup"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.attent.app/v1/leads/lookup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "1234"
}

{
  "message": "Invalid phone number format."
}

{
  "message": "Forbidden"
}

{
  "message": "Lead not found."
}

{
  "message": "Multiple leads match this phone number; provide outboundPhone."
}

{
  "message": "Internal Server Error"
}

API Reference

Leads

Calls

Tags

Usage

Do Not Contact

Look up lead by phone

Usage Notes

Authorizations

Query Parameters

Response

​Usage Notes

Authorizations

Query Parameters

Response

Usage Notes