Get a thread
GET
/v1/email/threads/{thread_id}
curl -X GET "https://us1.platform.bird.com/v1/email/threads/{thread_id}" \
-H "Authorization: Bearer $TOKEN"Returns a single conversation. Fetch the messages in the conversation with GET /v1/email/threads/{thread_id}/messages. A thread whose retention period has ended returns 410 Gone.
Response Payload
id
string
verplicht
Thread ID.
mailbox_id
string
verplicht
Mailbox this conversation belongs to.
channel
string
verplicht
Channel this conversation lives on. Always email.
contact_id
nullable string
verplicht
Contact linked to this conversation, or null when none is linked.
subject
nullable string
verplicht
Subject of the conversation, taken from its first message. Null when that message had no subject.
participants
array of string
verplicht
Addresses that appear on the retained messages in this conversation, including the mailbox's own address.
message_count
integer
verplicht
Number of retained messages in this conversation, both directions.
unread_count
integer
verplicht
Number of retained received messages in the inbox that are still unread.
last_message_at
string
verplicht
When the most recent retained message in this conversation was received or sent.
last_direction
string
verplicht
Direction of the most recent message — inbound for a received message, outbound for a sent one.
labels
array of string
verplicht
Labels applied to this conversation. A thread carries at most 20 labels.
created_at
string
verplicht
When the thread was created.
updated_at
string
verplicht
When the thread last changed.