Skip to main content
GET
/
v1
/
conversations
/
{id}
Get a conversation by ID
curl --request GET \
  --url https://api.heymarket.com/v1/conversations/{id}
{
  "id": 123,
  "channel": "<string>",
  "status": "<string>",
  "assigned": {
    "id": 123,
    "name": "<string>",
    "email": "<string>"
  },
  "inbox": {
    "id": 123,
    "name": "<string>"
  },
  "target": "<string>",
  "members": [
    {}
  ],
  "created": "<string>",
  "updated": "<string>",
  "read": true,
  "replied": true,
  "blocked": true,
  "muted": true,
  "snooze_till": "<string>"
}
Use this endpoint to retrieve a single conversation by its unique ID. The response includes the conversation’s channel, status, assigned user, inbox, contact information, and read state. This is useful for looking up conversation metadata before sending a message or updating a conversation’s state.

Path parameters

id
integer
required
The unique ID of the conversation to retrieve.

Example

curl --request GET \
  --url https://api.heymarket.com/v1/conversations/9920 \
  --header 'Authorization: Bearer YOUR_API_KEY'

Response

Returns a single Conversation object.
id
integer
The unique ID of the conversation.
channel
string
The channel type: sms, mms, email, or chat.
status
string
Whether the conversation is open or closed.
assigned
object
The team member the conversation is currently assigned to.
inbox
object
The inbox this conversation belongs to.
target
string
The contact’s phone number or email address.
members
object[]
An array of team members who are participants in this conversation.
created
string
The ISO 8601 timestamp of when the conversation was created.
updated
string
The ISO 8601 timestamp of the most recent activity in the conversation.
read
boolean
Whether the conversation has been read by the requesting user.
replied
boolean
Whether the conversation has received at least one reply.
blocked
boolean
Whether the contact associated with this conversation has been blocked.
muted
boolean
Whether notifications for this conversation are muted.
snooze_till
string
An ISO 8601 timestamp indicating when the snooze expires, if the conversation is currently snoozed. null if not snoozed.