Get Thread | AgentMail | Documentation

1 from agentmail import AgentMail 2 3 client = AgentMail( 4 base_url="https://api.agentmail.to", 5 api_key="YOUR_TOKEN_HERE" 6 ) 7 8 client.threads.get( 9 thread_id="thread_id" 10 )

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

Authentication

AuthorizationBearer

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

Path Parameters

thread_idstringRequired

ID of thread.

Response

This endpoint returns an object.

inbox_idstring

ID of inbox.

thread_idstring

ID of thread.

labelslist of strings

Labels of thread.

timestampdatetime

Timestamp of last sent or received message.

received_timestampdatetime

Timestamp of last received message.

sent_timestampdatetime

Timestamp of last sent message.

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

last_message_idstring

ID of last message in thread.

message_countinteger

Number of messages in thread.

sizeinteger

Size of thread in bytes.

updated_atdatetime

Time at which thread was last updated.

created_atdatetime

Time at which thread was created.

messageslist of objects

Messages in thread. Ordered by timestamp ascending.

subjectstring or null

Subject of thread.

previewstring or null

Text preview of last message in thread.

attachmentslist of objects or null

Attachments in thread.

Authentication

Path Parameters

Response

Errors