Search contacts
Search contacts by channel value, such as phone number or email address.
curl --request POST \
--url https://api.heymarket.com/v2/contacts/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_channels": [
{
"channel_ids": [
"14155551234",
"14155559876"
],
"channel_type": "phone"
}
]
}
'import requests
url = "https://api.heymarket.com/v2/contacts/search"
payload = { "contact_channels": [
{
"channel_ids": ["14155551234", "14155559876"],
"channel_type": "phone"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_channels: [{channel_ids: ['14155551234', '14155559876'], channel_type: 'phone'}]
})
};
fetch('https://api.heymarket.com/v2/contacts/search', 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.heymarket.com/v2/contacts/search",
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([
'contact_channels' => [
[
'channel_ids' => [
'14155551234',
'14155559876'
],
'channel_type' => 'phone'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.heymarket.com/v2/contacts/search"
payload := strings.NewReader("{\n \"contact_channels\": [\n {\n \"channel_ids\": [\n \"14155551234\",\n \"14155559876\"\n ],\n \"channel_type\": \"phone\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.heymarket.com/v2/contacts/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_channels\": [\n {\n \"channel_ids\": [\n \"14155551234\",\n \"14155559876\"\n ],\n \"channel_type\": \"phone\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymarket.com/v2/contacts/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_channels\": [\n {\n \"channel_ids\": [\n \"14155551234\",\n \"14155559876\"\n ],\n \"channel_type\": \"phone\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"avatar": "<string>",
"inbox_opt_outs": [
{
"inbox_id": 2,
"set_from_contact": false
}
],
"created": "<string>",
"creator_id": 123,
"custom": {},
"display_name": "<string>",
"email": "<string>",
"external_id": "<string>",
"external_ref": "<string>",
"first": "<string>",
"id": 123,
"inbox_id": 123,
"last": "<string>",
"note": [
{
"date": "<string>",
"id": "<string>",
"name": "<string>",
"text": "<string>",
"user_id": 123
}
],
"op": "<string>",
"parent_id": 123,
"phone": "<string>",
"rev": 123,
"shared": true,
"team_id": 123,
"type": "<string>",
"updated": "<string>",
"assigned_user_id": 123,
"tags": [
"<unknown>"
]
}
]"<string>"Unauthorizedtoo many requestserrorAuthorizations
Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.
API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.
Use the following JWT values:
{
"alg": "HS256",
"typ": "JWT"
}
{
"iss": "YOUR_API_SECRET_ID",
"iat": CURRENT_UNIX_TIMESTAMP
}
Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.
Sign the JWT with HMAC-SHA256 using this signing secret:
YOUR_API_SECRET_ID||YOUR_API_SECRET_KEY
Send the signed JWT as a bearer token:
Authorization: Bearer YOUR_SIGNED_JWT
Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.
Body
Search parameters
Exactly one of contact_channels or filters must be supplied; sending both is
rejected with contact_channels_and_filters.
One or more channel entries to search by. Each entry specifies the channel type and a list of IDs to match.
If channel_type is omitted, the type is inferred from the ID format (e.g. E.164 phone → phone, email format → email).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Matching contacts. A contact_channels search returns a bare array of contacts.
A filters search returns an object carrying contacts, total (the full match
count, not the size of the returned page) and resolved_filters (the filter set
the search ran, with custom-field references resolved to their titles, relative
dates resolved to the date or instant each compares against and the timezone
that applied).
- object[]
- object
Per-inbox opt-out breakdown, present on contact reads when the number has inbox-scoped opt-out rows. Omitted for contacts with no scoped rows.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
curl --request POST \
--url https://api.heymarket.com/v2/contacts/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_channels": [
{
"channel_ids": [
"14155551234",
"14155559876"
],
"channel_type": "phone"
}
]
}
'import requests
url = "https://api.heymarket.com/v2/contacts/search"
payload = { "contact_channels": [
{
"channel_ids": ["14155551234", "14155559876"],
"channel_type": "phone"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_channels: [{channel_ids: ['14155551234', '14155559876'], channel_type: 'phone'}]
})
};
fetch('https://api.heymarket.com/v2/contacts/search', 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.heymarket.com/v2/contacts/search",
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([
'contact_channels' => [
[
'channel_ids' => [
'14155551234',
'14155559876'
],
'channel_type' => 'phone'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.heymarket.com/v2/contacts/search"
payload := strings.NewReader("{\n \"contact_channels\": [\n {\n \"channel_ids\": [\n \"14155551234\",\n \"14155559876\"\n ],\n \"channel_type\": \"phone\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.heymarket.com/v2/contacts/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_channels\": [\n {\n \"channel_ids\": [\n \"14155551234\",\n \"14155559876\"\n ],\n \"channel_type\": \"phone\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymarket.com/v2/contacts/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_channels\": [\n {\n \"channel_ids\": [\n \"14155551234\",\n \"14155559876\"\n ],\n \"channel_type\": \"phone\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"avatar": "<string>",
"inbox_opt_outs": [
{
"inbox_id": 2,
"set_from_contact": false
}
],
"created": "<string>",
"creator_id": 123,
"custom": {},
"display_name": "<string>",
"email": "<string>",
"external_id": "<string>",
"external_ref": "<string>",
"first": "<string>",
"id": 123,
"inbox_id": 123,
"last": "<string>",
"note": [
{
"date": "<string>",
"id": "<string>",
"name": "<string>",
"text": "<string>",
"user_id": 123
}
],
"op": "<string>",
"parent_id": 123,
"phone": "<string>",
"rev": 123,
"shared": true,
"team_id": 123,
"type": "<string>",
"updated": "<string>",
"assigned_user_id": 123,
"tags": [
"<unknown>"
]
}
]"<string>"Unauthorizedtoo many requestserror