Get Thread | AgentMail | Documentation

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

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

Path parameters

inbox_idstringRequired

ID of inbox.

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.

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 timestamp ascending.

updated_atdatetime

Time at which thread was last updated.

created_atdatetime

Time at which thread was created.

subjectstring or null

Subject of thread.

previewstring or null

Text preview of last message in thread.

attachmentslist of objects or null

Attachments in thread.

Path parameters

Headers

Response

Errors