Look up contacts by email
curl --request POST \
--url https://core-api.getaptly.com/api/contacts/by-email \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"email": "[email protected]",
"limit": 20,
"skip": 0
}
'import requests
url = "https://core-api.getaptly.com/api/contacts/by-email"
payload = {
"email": "[email protected]",
"limit": 20,
"skip": 0
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '[email protected]', limit: 20, skip: 0})
};
fetch('https://core-api.getaptly.com/api/contacts/by-email', 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://core-api.getaptly.com/api/contacts/by-email",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '[email protected]',
'limit' => 20,
'skip' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-token: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://core-api.getaptly.com/api/contacts/by-email"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"limit\": 20,\n \"skip\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://core-api.getaptly.com/api/contacts/by-email")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"limit\": 20,\n \"skip\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/contacts/by-email")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"limit\": 20,\n \"skip\": 0\n}"
response = http.request(request)
puts response.read_body{
"contacts": [
{
"_id": "<string>",
"uuid": "<string>",
"firstname": "<string>",
"lastname": "<string>",
"fullName": "<string>",
"duogram": "<string>",
"photoId": "<string>",
"imageUrl": "<string>",
"email": "<string>",
"phone": "<string>",
"typeId": "<string>",
"companyId": "<string>",
"address": {},
"title": "<string>",
"alerts": [
{}
],
"company": "<string>",
"isCompany": true
}
]
}{
"error": "<string>",
"message": "<string>"
}Contacts
Look up contacts by email
Returns contacts whose email address matches one or more of the provided values. Matching is case-insensitive and exact. Results are scoped to your company.
POST
/
api
/
contacts
/
by-email
Look up contacts by email
curl --request POST \
--url https://core-api.getaptly.com/api/contacts/by-email \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"email": "[email protected]",
"limit": 20,
"skip": 0
}
'import requests
url = "https://core-api.getaptly.com/api/contacts/by-email"
payload = {
"email": "[email protected]",
"limit": 20,
"skip": 0
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: '[email protected]', limit: 20, skip: 0})
};
fetch('https://core-api.getaptly.com/api/contacts/by-email', 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://core-api.getaptly.com/api/contacts/by-email",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '[email protected]',
'limit' => 20,
'skip' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-token: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://core-api.getaptly.com/api/contacts/by-email"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"limit\": 20,\n \"skip\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://core-api.getaptly.com/api/contacts/by-email")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"limit\": 20,\n \"skip\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/contacts/by-email")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"limit\": 20,\n \"skip\": 0\n}"
response = http.request(request)
puts response.read_body{
"contacts": [
{
"_id": "<string>",
"uuid": "<string>",
"firstname": "<string>",
"lastname": "<string>",
"fullName": "<string>",
"duogram": "<string>",
"photoId": "<string>",
"imageUrl": "<string>",
"email": "<string>",
"phone": "<string>",
"typeId": "<string>",
"companyId": "<string>",
"address": {},
"title": "<string>",
"alerts": [
{}
],
"company": "<string>",
"isCompany": true
}
]
}{
"error": "<string>",
"message": "<string>"
}Authorizations
ApiKeyHeaderDelegateToken
Body
application/json
Response
Matching contacts.
Show child attributes
Show child attributes
⌘I