Skip to main content
POST
/
v1
/
contact
/
get
Paginate Contact
curl --request POST \
  --url https://api.heymarket.com/v1/contact/get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "12345678900",
  "avatar": "https://some.image.url.com/img.jpg",
  "custom": {},
  "display_name": "John Smith",
  "email": "john.s@heymarket.com",
  "first": "John",
  "last": "Smith",
  "assignee_id": 42,
  "tags": [
    {
      "tag_id": 1
    },
    {
      "tag_id": 2
    }
  ],
  "is_opted_out": true,
  "email_suppressions": [
    123
  ]
}
'
{
  "avatar": "<string>",
  "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>"
  ]
}
Use this endpoint when your integration has a phone number but not the contact ID.

Authorizations

​
Authorization
string
header
required

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

application/json

Contact json

​
phone
string<phone>
required
Example:

"12345678900"

​
avatar
string<url>
Example:

"https://some.image.url.com/img.jpg"

​
custom
object
​
display_name
string
Example:

"John Smith"

​
email
string<email>
Example:

"john.s@heymarket.com"

​
first
string
Example:

"John"

​
last
string
Example:

"Smith"

​
assignee_id
integer
Example:

42

​
tags
object[]
Example:
[{ "tag_id": 1 }, { "tag_id": 2 }]
​
is_opted_out
boolean
Example:

true

​
email_suppressions
integer[]

List of email suppression IDs to associate with the contact

Response

Contact in team

​
avatar
string
​
created
string
​
creator_id
integer
​
custom
object
​
display_name
string
​
email
string
​
external_id
string
​
external_ref
string
​
first
string
​
id
integer
​
inbox_id
integer
​
last
string
​
note
object[]
​
op
string
​
parent_id
integer
​
phone
string
​
rev
integer
​
shared
boolean
​
team_id
integer
​
type
string
​
updated
string
​
assigned_user_id
integer
​
tags
any[]