Skip to main content
GET
/
v1
/
contact
/
{id}
Get Contact
curl --request GET \
  --url https://api.heymarket.com/v1/contact/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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 you already have the v1 integer 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.

Path Parameters

​
id
integer
required

Contact ID

Response

OK

​
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[]