Get Thread | AgentMail | Documentation

1 from agentmail import AgentMail 2 client = AgentMail(api_key="YOUR_API_KEY", ) 3 client.threads.get(thread_id='thread_id', )

1 { 2 "inbox_id": "inbox_id", 3 "thread_id": "thread_id", 4 "event_id": "event_id", 5 "labels": [ 6 "labels", 7 "labels" 8 ], 9 "timestamp": "2024-01-15T09:30:00Z", 10 "senders": [ 11 "senders", 12 "senders" 13 ], 14 "recipients": [ 15 "recipients", 16 "recipients" 17 ], 18 "message_count": 1, 19 "messages": [ 20 { 21 "inbox_id": "inbox_id", 22 "thread_id": "thread_id", 23 "message_id": "message_id", 24 "event_id": "event_id", 25 "labels": [ 26 "labels", 27 "labels" 28 ], 29 "timestamp": "2024-01-15T09:30:00Z", 30 "from": "from", 31 "to": [ 32 "to", 33 "to" 34 ], 35 "cc": [ 36 "cc", 37 "cc" 38 ], 39 "bcc": [ 40 "bcc", 41 "bcc" 42 ], 43 "subject": "subject", 44 "preview": "preview", 45 "text": "text", 46 "html": "html", 47 "attachments": [ 48 { 49 "attachment_id": "attachment_id", 50 "filename": "filename", 51 "content_type": "content_type", 52 "size": 1, 53 "inline": true 54 }, 55 { 56 "attachment_id": "attachment_id", 57 "filename": "filename", 58 "content_type": "content_type", 59 "size": 1, 60 "inline": true 61 } 62 ], 63 "in_reply_to": "in_reply_to", 64 "references": [ 65 "references", 66 "references" 67 ] 68 }, 69 { 70 "inbox_id": "inbox_id", 71 "thread_id": "thread_id", 72 "message_id": "message_id", 73 "event_id": "event_id", 74 "labels": [ 75 "labels", 76 "labels" 77 ], 78 "timestamp": "2024-01-15T09:30:00Z", 79 "from": "from", 80 "to": [ 81 "to", 82 "to" 83 ], 84 "cc": [ 85 "cc", 86 "cc" 87 ], 88 "bcc": [ 89 "bcc", 90 "bcc" 91 ], 92 "subject": "subject", 93 "preview": "preview", 94 "text": "text", 95 "html": "html", 96 "attachments": [ 97 { 98 "attachment_id": "attachment_id", 99 "filename": "filename", 100 "content_type": "content_type", 101 "size": 1, 102 "inline": true 103 }, 104 { 105 "attachment_id": "attachment_id", 106 "filename": "filename", 107 "content_type": "content_type", 108 "size": 1, 109 "inline": true 110 } 111 ], 112 "in_reply_to": "in_reply_to", 113 "references": [ 114 "references", 115 "references" 116 ] 117 } 118 ], 119 "subject": "subject", 120 "preview": "preview", 121 "attachments": [ 122 { 123 "message_id": "message_id", 124 "attachment_id": "attachment_id", 125 "filename": "filename", 126 "content_type": "content_type", 127 "size": 1, 128 "inline": true 129 }, 130 { 131 "message_id": "message_id", 132 "attachment_id": "attachment_id", 133 "filename": "filename", 134 "content_type": "content_type", 135 "size": 1, 136 "inline": true 137 } 138 ] 139 }

Path parameters

thread_idstringRequired

ID of thread.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

This endpoint returns an object.

inbox_idstring

ID of inbox.

thread_idstring

ID of thread.

event_idstring

Event ID of thread.

labelslist of strings

Labels of thread.

timestampdatetime

Time at which last message was sent.

senderslist of strings

Senders in thread. In format username@domain.com or Display Name <username@domain.com>.

recipientslist of strings

Recipients in thread. In format username@domain.com or Display Name <username@domain.com>.

message_countinteger

Number of messages in thread.

messageslist of objects

Messages in thread. Ordered by sent_at ascending.

subjectstringOptional

Subject of thread.

previewstringOptional

Text preview of last message in thread.

attachmentslist of objectsOptional

Attachments in thread.

Path parameters

Headers

Response

Errors