Skip to content

Get Reply

GET
/inbox/{reply_id}

Get a single inbox thread by ID. With include_record_context=true it also carries the custom records pinned to the thread that this key may read, and a count of those it may not; the response is otherwise unchanged.

Authorizations

Parameters

Path Parameters

reply_id
required

Thread/reply ID

string

Thread/reply ID

Query Parameters

channel

Channel type

string
default: email
Allowed values: email sms linkedin

Channel type

include_record_context

Also return the custom records pinned to this thread that this key may read (objects:read)

boolean

Also return the custom records pinned to this thread that this key may read (objects:read)

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
assignees
Array<object>
object
key
additional properties
any
channel
required
string
contact
Any of:
object
key
additional properties
any
created_at
Any of:
string
from_number
Any of:
string
id
required
string
linkedin_account_id
Any of:
integer
mailbox
Any of:
string
messages
Array<object>
object
content
Any of:
string
date
Any of:
string
from_address
Any of:
string
is_draft
boolean
message_id
Any of:
string
responder
Any of:
string
to_addresses
Array<string>
record_context
Any of:
Array<object>

A custom record pinned to the thread that this key may read (ENG-05, custom objects PR 3.7).

object
label
required

Plain text; never markup or a link

string
object_label
required
string
object_slug
required
string
record_id
required
string
revision
required
integer
record_context_unavailable
Any of:
integer
status
Any of:
string
subject
Any of:
string
tags
Array<object>
object
key
additional properties
any
to_number
Any of:
string
updated_at
Any of:
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string