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.
Payload de resposta
id
string
obrigatório
Thread ID.
mailbox_id
string
obrigatório
Mailbox this conversation belongs to.
channel
string
obrigatório
Channel this conversation lives on. Always email.
contact_id
nullable string
obrigatório
Contact linked to this conversation, or null when none is linked.
subject
nullable string
obrigatório
Subject of the conversation, taken from its first message. Null when that message had no subject.
participants
array of string
obrigatório
Addresses that appear on the retained messages in this conversation, including the mailbox's own address.
message_count
integer
obrigatório
Number of retained messages in this conversation, both directions.
unread_count
integer
obrigatório
Number of retained received messages that are still unread. Spam and blocked mail is not counted.
last_message_at
string
obrigatório
When the most recent retained message in this conversation was received or sent.
last_direction
string
obrigatório
Direction of the most recent message — inbound for a received message, outbound for a sent one.
Possible values: inbound, outbound
labels
array of string
obrigatório
Labels on this conversation. Exactly one system placement label is always present — inbox, archive (filed away, done for now), spam (the opening message failed sender authentication), or blocked (rejected by the mailbox's receive policy or rules) — set by the message that started the conversation. Move a conversation by updating its labels: add spam to file it as spam, add archive to clean it out of the inbox, and add inbox — or remove spam, blocked, or archive — to bring it back. An archived conversation returns to the inbox by itself when a new message arrives. Custom labels share the same list; a conversation carries at most 20.
created_at
string
obrigatório
When the thread was created.
updated_at
string
obrigatório
When the thread last changed.
highlights
object
Matched search fragments, keyed by the field that matched. Returned only by thread search; omitted when listing threads.
Mostrar atributos secundários
highlights.subject
array of string
Matched fragments from the conversation's subject.
highlights.text
array of string
Matched fragments from a message's body text.