Skip to main content
GET
/
v1
/
conversations
/
{id}
Get Conversation by ID
curl --request GET \
  --url https://api.heymarket.com/v1/conversations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "assigned": 123,
  "blocked": true,
  "channel": "<string>",
  "created": "<string>",
  "creator": 123,
  "email_noti": true,
  "id": 123,
  "inbox": 123,
  "last_inbound": 123,
  "local_id": "<string>",
  "members": [
    {
      "id": 123,
      "name": "<string>"
    }
  ],
  "muted": true,
  "name": "<string>",
  "noreply": "<string>",
  "op": "<string>",
  "read": 123,
  "replied": true,
  "snooze_till": "<string>",
  "status": "<string>",
  "super": 123,
  "support": true,
  "target": "<string>",
  "type": "<string>",
  "updated": "<string>"
}
Use this endpoint to retrieve conversation metadata before sending a reply or changing conversation state.

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

Conversations ID

Response

OK

​
assigned
integer
​
blocked
boolean
​
channel
string
​
created
string
​
creator
integer
​
email_noti
boolean
​
id
integer
​
inbox
integer
​
last_inbound
integer
​
local_id
string
​
members
object[]
​
muted
boolean
​
name
string
​
noreply
string
​
op
string
​
read
integer
​
replied
boolean
​
snooze_till
string
​
status
string
​
super
integer
​
support
boolean
​
target
string
​
type
string
​
updated
string